Struct libp2p_core::upgrade::FromFnUpgrade

pub struct FromFnUpgrade<P, F> { /* private fields */ }

Implements the UpgradeInfo, InboundUpgrade and OutboundUpgrade traits.

The upgrade consists in calling the function passed when creating this struct.

Trait Implementations

impl<P: Clone, F: Clone> Clone for FromFnUpgrade<P, F>

fn clone(&self) -> FromFnUpgrade<P, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<P: Debug, F: Debug> Debug for FromFnUpgrade<P, F>

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

Formats the value using the given formatter.

impl<C, P, F, Fut, Err, Out> InboundUpgrade<C> for FromFnUpgrade<P, F>where
    P: ProtocolName + Clone,
    F: FnOnce(C, Endpoint) -> Fut,
    Fut: Future<Output = Result<Out, Err>>,

type Output = Out

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

type Error = Err

Possible error during the handshake.

type Future = Fut

Future that performs the handshake with the remote.

fn upgrade_inbound(self, sock: 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, F, Fut, Err, Out> OutboundUpgrade<C> for FromFnUpgrade<P, F>where
    P: ProtocolName + Clone,
    F: FnOnce(C, Endpoint) -> Fut,
    Fut: Future<Output = Result<Out, Err>>,

type Output = Out

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

type Error = Err

Possible error during the handshake.

type Future = Fut

Future that performs the handshake with the remote.

fn upgrade_outbound(self, sock: 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, F> UpgradeInfo for FromFnUpgrade<P, F>where
    P: ProtocolName + 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.