Struct libp2p::core::transport::upgrade::Builder

pub struct Builder<T> { /* private fields */ }

A Builder facilitates upgrading of a Transport for use with a Swarm.

The upgrade process is defined by the following stages:

authenticate{1} -> apply{*} -> multiplex{1}

It thus enforces the following invariants on every transport obtained from multiplex:

1. The transport must be authenticated and multiplexed.
2. Authentication must precede the negotiation of a multiplexer.
3. Applying a multiplexer is the last step in the upgrade process.
4. The Transport::Output conforms to the requirements of a Swarm, namely a tuple of a PeerId (from the authentication upgrade) and a StreamMuxer (from the multiplexing upgrade).

Implementations

impl<T> Builder<T>

where T: Transport, <T as Transport>::Error: 'static,

pub fn new(inner: T, version: Version) -> Builder<T>

Creates a Builder over the given (base) Transport.

pub fn authenticate<C, D, U, E>( self, upgrade: U, ) -> Authenticated<AndThen<T, impl FnOnce(C, ConnectedPoint) -> Authenticate<C, U> + Clone>>

where T: Transport<Output = C>, C: AsyncRead + AsyncWrite + Unpin, D: AsyncRead + AsyncWrite + Unpin, U: InboundConnectionUpgrade<Negotiated<C>, Output = (PeerId, D), Error = E> + OutboundConnectionUpgrade<Negotiated<C>, Output = (PeerId, D), Error = E> + Clone, E: Error + 'static,

Upgrades the transport to perform authentication of the remote.

The supplied upgrade receives the I/O resource C and must produce a pair (PeerId, D), where D is a new I/O resource. The upgrade must thus at a minimum identify the remote, which typically involves the use of a cryptographic authentication protocol in the context of establishing a secure channel.

Transitions

• I/O upgrade: C -> (PeerId, D).
• Transport output: C -> (PeerId, D)

Trait Implementations

impl<T> Clone for Builder<T>

where T: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.