Struct libp2p_core::transport::OptionalTransport
source · [−]pub struct OptionalTransport<T>(_);
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
sourceimpl<T> OptionalTransport<T>
impl<T> OptionalTransport<T>
sourcepub fn some(inner: T) -> OptionalTransport<T>
pub fn some(inner: T) -> OptionalTransport<T>
Builds an OptionalTransport
with the given transport in an enabled
state.
sourcepub fn none() -> OptionalTransport<T>
pub fn none() -> OptionalTransport<T>
Builds a disabled OptionalTransport
.
Trait Implementations
sourceimpl<T: Clone> Clone for OptionalTransport<T>
impl<T: Clone> Clone for OptionalTransport<T>
sourcefn clone(&self) -> OptionalTransport<T>
fn clone(&self) -> OptionalTransport<T>
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl<T: Debug> Debug for OptionalTransport<T>
impl<T: Debug> Debug for OptionalTransport<T>
sourceimpl<T> From<T> for OptionalTransport<T>
impl<T> From<T> for OptionalTransport<T>
sourceimpl<T> Transport for OptionalTransport<T> where
T: Transport,
impl<T> Transport for OptionalTransport<T> where
T: Transport,
type Output = T::Output
type Output = T::Output
The result of a connection setup process, including protocol upgrades. Read more
type ListenerUpgrade = T::ListenerUpgrade
type ListenerUpgrade = T::ListenerUpgrade
sourcefn listen_on(
self,
addr: Multiaddr
) -> Result<Self::Listener, TransportError<Self::Error>>
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
). Read more
sourcefn address_translation(
&self,
server: &Multiaddr,
observed: &Multiaddr
) -> Option<Multiaddr>
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
sourcefn boxed(self) -> Boxed<Self::Output> where
Self: Transport + Sized + Clone + Send + Sync + 'static,
Self::Dial: Send + 'static,
Self::Listener: Send + 'static,
Self::ListenerUpgrade: Send + 'static,
Self::Error: Send + Sync,
fn boxed(self) -> Boxed<Self::Output> where
Self: Transport + Sized + Clone + Send + Sync + 'static,
Self::Dial: Send + 'static,
Self::Listener: Send + 'static,
Self::ListenerUpgrade: Send + 'static,
Self::Error: Send + Sync,
Boxes the transport, including custom transport errors.
sourcefn map<F, O>(self, f: F) -> Map<Self, F> where
Self: Sized,
F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone,
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.
sourcefn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
Self: Sized,
F: FnOnce(Self::Error) -> E + Clone,
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.
sourcefn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
Self: Sized,
U: Transport,
<U as Transport>::Error: 'static,
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
sourcefn 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,
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. Read more
impl<T: Copy> Copy for OptionalTransport<T>
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> Unpin for OptionalTransport<T> where
T: Unpin,
impl<T> UnwindSafe for OptionalTransport<T> where
T: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more