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

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§

source§

impl<T> Builder<T>where T: Transport, T::Error: 'static,

source

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

Creates a Builder over the given (base) Transport.

source

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: InboundUpgrade<Negotiated<C>, Output = (PeerId, D), Error = E> + OutboundUpgrade<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§

source§

impl<T: Clone> Clone for Builder<T>

source§

fn clone(&self) -> Builder<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

Auto Trait Implementations§

§

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

§

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

§

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

§

impl<T> Unpin for Builder<T>where T: Unpin,

§

impl<T> UnwindSafe for Builder<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<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.
source§

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

source§

fn vzip(self) -> V