Struct libp2p::core::upgrade::FromFnUpgrade

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

Implements the UpgradeInfo, InboundUpgrade and OutboundUpgrade traits.

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<C, P, F, Fut, Err, Out> InboundUpgrade<C> for FromFnUpgrade<P, F> where
    F: FnOnce(C, Endpoint) -> Fut,
    P: ProtocolName + Clone,
    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.

pub fn upgrade_inbound(
    self,
    sock: C,
    <FromFnUpgrade<P, F> as UpgradeInfo>::Info
) -> <FromFnUpgrade<P, F> as InboundUpgrade<C>>::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
    F: FnOnce(C, Endpoint) -> Fut,
    P: ProtocolName + Clone,
    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.

pub fn upgrade_outbound(
    self,
    sock: C,
    <FromFnUpgrade<P, F> as UpgradeInfo>::Info
) -> <FromFnUpgrade<P, F> as OutboundUpgrade<C>>::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.

pub fn protocol_info(&self) -> <FromFnUpgrade<P, F> as UpgradeInfo>::InfoIter

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