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§
source§impl<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§
source§impl<T: Clone> Clone for OptionalTransport<T>
impl<T: Clone> Clone for OptionalTransport<T>
source§fn clone(&self) -> OptionalTransport<T>
fn clone(&self) -> OptionalTransport<T>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T: Debug> Debug for OptionalTransport<T>
impl<T: Debug> Debug for OptionalTransport<T>
source§impl<T> From<T> for OptionalTransport<T>
impl<T> From<T> for OptionalTransport<T>
source§impl<T> Transport for OptionalTransport<T>where
T: Transport,
impl<T> Transport for OptionalTransport<T>where T: Transport,
§type Output = <T as Transport>::Output
type Output = <T as Transport>::Output
The result of a connection setup process, including protocol upgrades. Read more
§type ListenerUpgrade = <T as Transport>::ListenerUpgrade
type ListenerUpgrade = <T as Transport>::ListenerUpgrade
source§fn listen_on(
&mut self,
addr: Multiaddr
) -> Result<ListenerId, TransportError<Self::Error>>
fn listen_on( &mut self, addr: Multiaddr ) -> Result<ListenerId, TransportError<Self::Error>>
Listens on the given
Multiaddr
for inbound connections.source§fn remove_listener(&mut self, id: ListenerId) -> bool
fn remove_listener(&mut self, id: ListenerId) -> bool
Remove a listener. Read more
source§fn dial_as_listener(
&mut self,
addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>
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 moresource§fn 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 moresource§fn poll(
self: Pin<&mut Self>,
cx: &mut Context<'_>
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>
fn poll( self: Pin<&mut Self>, cx: &mut Context<'_> ) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>
Poll for
TransportEvent
s. Read moresource§fn map<F, O>(self, f: F) -> Map<Self, F>where
Self: Sized,
F: FnOnce(Self::Output, ConnectedPoint) -> O,
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,
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,
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
impl<T: Copy> Copy for OptionalTransport<T>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more