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

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§

source§

impl<T> OptionalTransport<T>

source

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

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

source

pub fn none() -> OptionalTransport<T>

Builds a disabled OptionalTransport.

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

fn from(inner: T) -> Self

Converts to this type from the input type.
source§

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. Read more
§

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. Read more
§

type Dial = <T as Transport>::Dial

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

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.
source§

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

Remove a listener. Read more
source§

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

Dials the given Multiaddr, returning a future for a pending outbound connection. Read more
source§

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. Read more
source§

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. Read more
source§

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

source§

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.
source§

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.
source§

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. Read more
source§

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. Read more
source§

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

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

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

source§

impl<'pin, T> Unpin for OptionalTransport<T>where __OptionalTransport<'pin, T>: Unpin,

Auto Trait Implementations§

§

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

§

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

§

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

§

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

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<!> for T

source§

fn from(t: !) -> T

Converts to this type from the input type.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same<T> for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for Twhere T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V