Struct libp2p_core::upgrade::ReadyUpgrade

pub struct ReadyUpgrade<P> { /* private fields */ }

Implementation of UpgradeInfo, InboundUpgrade and OutboundUpgrade that directly yields the substream.

Implementations

impl<P> ReadyUpgrade<P>

pub fn new(protocol_name: P) -> Self

Trait Implementations

impl<P: Clone> Clone for ReadyUpgrade<P>

fn clone(&self) -> ReadyUpgrade<P>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug> Debug for ReadyUpgrade<P>

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

Formats the value using the given formatter.

impl<C, P> InboundUpgrade<C> for ReadyUpgrade<P>

where P: AsRef<str> + Clone,

type Output = C

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Void

Possible error during the handshake.

type Future = Ready<Result<<ReadyUpgrade<P> as InboundUpgrade<C>>::Output, <ReadyUpgrade<P> as InboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, stream: C, _: Self::Info) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl<C, P> OutboundUpgrade<C> for ReadyUpgrade<P>

where P: AsRef<str> + Clone,

type Output = C

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Void

Possible error during the handshake.

type Future = Ready<Result<<ReadyUpgrade<P> as OutboundUpgrade<C>>::Output, <ReadyUpgrade<P> as OutboundUpgrade<C>>::Error>>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, stream: C, _: Self::Info) -> Self::Future

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake.

impl<P> UpgradeInfo for ReadyUpgrade<P>

where P: AsRef<str> + Clone,

type Info = P

Opaque type representing a negotiable protocol.

type InfoIter = Once<P>

Iterator returned by protocol_info.

fn protocol_info(&self) -> Self::InfoIter

Returns the list of protocols that are supported. Used during the negotiation process.

impl<P: Copy> Copy for ReadyUpgrade<P>