Struct libp2p_core::transport::OptionalTransport

pub struct OptionalTransport<T>(/* private fields */);

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.

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

Performs copy-assignment from source.

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

Converts to this type from the input type.

impl<T> Transport for OptionalTransport<T>

where T: Transport,

type Output = <T as Transport>::Output

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

type Error = <T as Transport>::Error

An error that occurred during connection setup.

type ListenerUpgrade = <T as Transport>::ListenerUpgrade

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

type Dial = <T as Transport>::Dial

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

fn listen_on( &mut self, id: ListenerId, addr: Multiaddr, ) -> Result<(), TransportError<Self::Error>>

Listens on the given Multiaddr for inbound connections with a provided ListenerId.

fn remove_listener(&mut self, id: ListenerId) -> bool

Remove a listener.

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

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

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

As Transport::dial but has the local node act as a listener on the outgoing connection.

fn address_translation( &self, server: &Multiaddr, observed: &Multiaddr, ) -> Option<Multiaddr>

Performs a transport-specific mapping of an address observed by a remote onto a local listen address to yield an address for the local node that may be reachable for other peers.

fn poll( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>

Poll for TransportEvents.

fn map<F, O>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnOnce(Self::Output, ConnectedPoint) -> O,

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,

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, 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 upgrade(self, version: Version) -> Builder<Self>

where Self: Sized, Self::Error: 'static,

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

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

impl<'pin, T> Unpin for OptionalTransport<T>

where __OptionalTransport<'pin, T>: Unpin,