Struct libp2p::simple::SimpleProtocol

pub struct SimpleProtocol<F> { /* private fields */ }

Implementation of ConnectionUpgrade. Convenient to use with small protocols.

Implementations

impl<F> SimpleProtocol<F>

pub fn new<N>(info: N, upgrade: F) -> SimpleProtocol<F>where N: Into<Bytes>,

Builds a SimpleProtocol.

Trait Implementations

impl<F> Clone for SimpleProtocol<F>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for SimpleProtocol<F>

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

Formats the value using the given formatter.

impl<C, F, O, A, E> InboundUpgrade<C> for SimpleProtocol<F>where C: AsyncRead + AsyncWrite, F: Fn(C) -> O, O: Future<Output = Result<A, E>>,

type Output = A

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

type Error = E

Possible error during the handshake.

type Future = O

Future that performs the handshake with the remote.

fn upgrade_inbound(self, socket: 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, F, O, A, E> OutboundUpgrade<C> for SimpleProtocol<F>where C: AsyncRead + AsyncWrite, F: Fn(C) -> O, O: Future<Output = Result<A, E>>,

type Output = A

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

type Error = E

Possible error during the handshake.

type Future = O

Future that performs the handshake with the remote.

fn upgrade_outbound(self, socket: 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<F> UpgradeInfo for SimpleProtocol<F>

type Info = Bytes

Opaque type representing a negotiable protocol.

type InfoIter = Once<<SimpleProtocol<F> as UpgradeInfo>::Info>

Iterator returned by protocol_info.

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

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