Struct libp2p_core::transport::Boxed

pub struct Boxed<O> { /* private fields */ }

A Boxed transport is a Transport whose Dial, Listener and ListenerUpgrade futures are Boxed and only the Output and Error types are captured in type variables.

Trait Implementations

impl<O> Debug for Boxed<O>

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

Formats the value using the given formatter.

impl<O> FusedStream for Boxed<O>

fn is_terminated(&self) -> bool

Returns true if the stream should no longer be polled.

impl<O> Stream for Boxed<O>

type Item = TransportEvent<Pin<Box<dyn Future<Output = Result<O, Error>> + Send + 'static, Global>>, Error>

Values yielded by the stream.

fn poll_next(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted.

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream.

impl<O> Transport for Boxed<O>

type Output = O

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

type Error = Error

An error that occurred during connection setup.

type ListenerUpgrade = Pin<Box<dyn Future<Output = Result<O, Error>> + Send + 'static, Global>>

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

type Dial = Pin<Box<dyn Future<Output = Result<O, Error>> + Send + 'static, Global>>

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

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

Listens on the given Multiaddr for inbound connections.

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.