Struct libp2p_core::transport::OptionalTransport

pub struct OptionalTransport<T>(_);

Transport that is possibly disabled.

An OptionalTransport<T> is a wrapper around an Option<T>. If it is disabled (read: contains None), then any attempt to dial or listen will return MultiaddrNotSupported. If it is enabled (read: contains Some), then dialing and listening will be handled by the inner transport.

Implementations

impl<T> OptionalTransport<T>

pub fn some(inner: T) -> OptionalTransport<T>

Builds an OptionalTransport with the given transport in an enabled state.

pub fn none() -> OptionalTransport<T>

Builds a disabled OptionalTransport.

Trait Implementations

impl<T: Clone> Clone for OptionalTransport<T>

fn clone(&self) -> OptionalTransport<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Copy> Copy for OptionalTransport<T>

impl<T: Debug> Debug for OptionalTransport<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<T> for OptionalTransport<T>

fn from(inner: T) -> Self

Performs the conversion.

impl<T> Transport for OptionalTransport<T> where
    T: Transport, 

type Output = T::Output

The result of a connection setup process, including protocol upgrades.

type Error = T::Error

An error that occurred during connection setup.

type Listener = T::Listener

A stream of Outputs for inbound connections.

type ListenerUpgrade = T::ListenerUpgrade

A pending Output for an inbound connection, obtained from the Listener stream.

type Dial = T::Dial

A pending Output for an outbound connection, obtained from dialing.

fn listen_on(
    self,
    addr: Multiaddr
) -> Result<Self::Listener, TransportError<Self::Error>>

Listens on the given Multiaddr, producing a stream of pending, inbound connections and addresses this transport is listening on (cf. ListenerEvent).

fn dial(
    self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

Dials the given Multiaddr, returning a future for a pending outbound connection.

fn boxed(self) -> Boxed<Self::Output, Self::Error> where
    Self: Sized + Clone + Send + Sync + 'static,
    Self::Dial: Send + 'static,
    Self::Listener: Send + 'static,
    Self::ListenerUpgrade: Send + 'static, 

Turns the transport into an abstract boxed (i.e. heap-allocated) transport.

fn map<F, O>(self, f: F) -> Map<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone, 

Applies a function on the connections created by the transport.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    Self: Sized,
    F: FnOnce(Self::Error) -> E + Clone, 

Applies a function on the errors generated by the futures of the transport.

fn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
    Self: Sized,
    U: Transport,
    <U as Transport>::Error: 'static, 

Adds a fallback transport that is used when encountering errors while establishing inbound or outbound connections.

fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C> where
    Self: Sized,
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error + 'static, 

Applies a function producing an asynchronous result to every connection created by this transport.

fn timeout(self, timeout: Duration) -> TransportTimeout<Self> where
    Self: Sized, 

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

fn outbound_timeout(self, timeout: Duration) -> TransportTimeout<Self> where
    Self: Sized, 

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

fn inbound_timeout(self, timeout: Duration) -> TransportTimeout<Self> where
    Self: Sized, 

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.

fn upgrade(self, version: Version) -> Builder<Self> where
    Self: Sized,
    Self::Error: 'static, 

Begins a series of protocol upgrades via an upgrade::Builder.