Trait libp2p::InboundUpgrade

pub trait InboundUpgrade<C>: UpgradeInfo {
    type Output;
    type Error;
    type Future: Future;
    fn upgrade_inbound(self, socket: C, info: Self::Info) -> Self::Future;
}

Possible upgrade on an inbound connection or substream.

Associated Types

type Output

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

type Error

Possible error during the handshake.

type Future: Future

Future that performs the handshake with the remote.

Required methods

fn upgrade_inbound(self, socket: C, info: 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.

The info is the identifier of the protocol, as produced by protocol_info.

Implementors

impl InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for Ping

type Output = Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>

type Error = Void

type Future = Ready<Result<<Ping as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <Ping as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>>

impl<C> InboundUpgrade<C> for DeniedUpgrade

type Output = Void

type Error = Void

type Future = Pending<Result<<DeniedUpgrade as InboundUpgrade<C>>::Output, <DeniedUpgrade as InboundUpgrade<C>>::Error>>

impl<C> InboundUpgrade<C> for DeflateConfig where
    C: AsyncRead + AsyncWrite, 

type Output = DeflateOutput<C>

type Error = Error

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

impl<C> InboundUpgrade<C> for KademliaProtocolConfig where
    C: AsyncRead + AsyncWrite + Unpin, 

type Output = AndThen<With<ErrInto<Framed<C, UviBytes<Cursor<Vec<u8, Global>>>>, Error>, Cursor<Vec<u8, Global>>, KadResponseMsg, Ready<Result<Cursor<Vec<u8, Global>>, Error>>, fn(KadResponseMsg) -> Ready<Result<Cursor<Vec<u8, Global>>, Error>>>, Ready<Result<KadRequestMsg, Error>>, fn(BytesMut) -> Ready<Result<KadRequestMsg, Error>>>

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

type Error = Error

impl<C> InboundUpgrade<C> for MplexConfig where
    C: AsyncRead + AsyncWrite + Unpin, 

type Output = Multiplex<C>

type Error = Error

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

impl<C> InboundUpgrade<C> for PlainText1Config

type Output = C

type Error = Void

type Future = Ready<Result<C, <PlainText1Config as InboundUpgrade<C>>::Error>>

impl<C> InboundUpgrade<C> for PlainText2Config where
    C: 'static + AsyncRead + AsyncWrite + Send + Unpin, 

type Output = (PeerId, PlainTextOutput<C>)

type Error = PlainTextError

type Future = Pin<Box<dyn Future<Output = Result<<PlainText2Config as InboundUpgrade<C>>::Output, <PlainText2Config as InboundUpgrade<C>>::Error>> + Send + 'static, Global>>

impl<C> InboundUpgrade<C> for YamuxConfig where
    C: 'static + AsyncRead + AsyncWrite + Send + Unpin, 

type Output = Yamux<Incoming<C>>

type Error = Error

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

impl<C> InboundUpgrade<C> for YamuxLocalConfig where
    C: 'static + AsyncRead + AsyncWrite + Unpin, 

type Output = Yamux<LocalIncoming<C>>

type Error = Error

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

impl<C, A, B, TA, TB, EA, EB> InboundUpgrade<C> for EitherUpgrade<A, B> where
    A: InboundUpgrade<C, Output = TA, Error = EA>,
    B: InboundUpgrade<C, Output = TB, Error = EB>, 

type Output = EitherOutput<TA, TB>

type Error = EitherError<EA, EB>

type Future = EitherFuture2<<A as InboundUpgrade<C>>::Future, <B as InboundUpgrade<C>>::Future>

impl<C, A, B, TA, TB, EA, EB> InboundUpgrade<C> for SelectUpgrade<A, B> where
    A: InboundUpgrade<C, Output = TA, Error = EA>,
    B: InboundUpgrade<C, Output = TB, Error = EB>, 

type Output = EitherOutput<TA, TB>

type Error = EitherError<EA, EB>

type Future = EitherFuture2<<A as InboundUpgrade<C>>::Future, <B as InboundUpgrade<C>>::Future>

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

type Error = E

type Future = O

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

type Error = Err

type Future = Fut

impl<C, T> InboundUpgrade<C> for OptionalUpgrade<T> where
    T: InboundUpgrade<C>, 

type Output = <T as InboundUpgrade<C>>::Output

type Error = <T as InboundUpgrade<C>>::Error

type Future = <T as InboundUpgrade<C>>::Future

impl<C, U, F> InboundUpgrade<C> for MapOutboundUpgrade<U, F> where
    U: InboundUpgrade<C>, 

type Output = <U as InboundUpgrade<C>>::Output

type Error = <U as InboundUpgrade<C>>::Error

type Future = <U as InboundUpgrade<C>>::Future

impl<C, U, F> InboundUpgrade<C> for MapOutboundUpgradeErr<U, F> where
    U: InboundUpgrade<C>, 

type Output = <U as InboundUpgrade<C>>::Output

type Error = <U as InboundUpgrade<C>>::Error

type Future = <U as InboundUpgrade<C>>::Future

impl<C, U, F, T> InboundUpgrade<C> for MapInboundUpgrade<U, F> where
    U: InboundUpgrade<C>,
    F: FnOnce(<U as InboundUpgrade<C>>::Output) -> T, 

type Output = T

type Error = <U as InboundUpgrade<C>>::Error

type Future = MapFuture<<U as InboundUpgrade<C>>::Future, F>

impl<C, U, F, T> InboundUpgrade<C> for MapInboundUpgradeErr<U, F> where
    U: InboundUpgrade<C>,
    F: FnOnce(<U as InboundUpgrade<C>>::Error) -> T, 

type Output = <U as InboundUpgrade<C>>::Output

type Error = T

type Future = MapErrFuture<<U as InboundUpgrade<C>>::Future, F>

impl<T, C> InboundUpgrade<T> for NoiseConfig<IX, C, ()> where
    T: 'static + AsyncRead + AsyncWrite + Unpin + Send,
    C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
    NoiseConfig<IX, C, ()>: UpgradeInfo, 

type Output = (RemoteIdentity<C>, NoiseOutput<T>)

type Error = NoiseError

type Future = Handshake<T, C>

impl<T, C> InboundUpgrade<T> for NoiseConfig<XX, C, ()> where
    T: 'static + AsyncRead + AsyncWrite + Unpin + Send,
    C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
    NoiseConfig<XX, C, ()>: UpgradeInfo, 

type Output = (RemoteIdentity<C>, NoiseOutput<T>)

type Error = NoiseError

type Future = Handshake<T, C>

impl<T, C, R> InboundUpgrade<T> for NoiseConfig<IK, C, R> where
    T: 'static + AsyncRead + AsyncWrite + Unpin + Send,
    C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
    NoiseConfig<IK, C, R>: UpgradeInfo, 

type Output = (RemoteIdentity<C>, NoiseOutput<T>)

type Error = NoiseError

type Future = Handshake<T, C>

impl<T, P, C, R> InboundUpgrade<T> for NoiseAuthenticated<P, C, R> where
    T: 'static + AsyncRead + AsyncWrite + Send,
    C: 'static + Protocol<C> + AsRef<[u8]> + Zeroize + Send,
    NoiseConfig<P, C, R>: 'static,
    NoiseConfig<P, C, R>: UpgradeInfo,
    NoiseConfig<P, C, R>: InboundUpgrade<T>,
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Future: Send,
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Output == (RemoteIdentity<C>, NoiseOutput<T>),
    <NoiseConfig<P, C, R> as InboundUpgrade<T>>::Error == NoiseError, 

type Output = (PeerId, NoiseOutput<T>)

type Error = NoiseError

type Future = Pin<Box<dyn Future<Output = Result<<NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Output, <NoiseAuthenticated<P, C, R> as InboundUpgrade<T>>::Error>> + Send + 'static, Global>>

impl<TCodec> InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for ResponseProtocol<TCodec> where
    TCodec: 'static + RequestResponseCodec + Send, 

type Output = bool

type Error = Error

type Future = Pin<Box<dyn Future<Output = Result<<ResponseProtocol<TCodec> as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <ResponseProtocol<TCodec> as InboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>> + Send + 'static, Global>>

impl<TSocket> InboundUpgrade<TSocket> for FloodsubProtocol where
    TSocket: 'static + AsyncRead + AsyncWrite + Send + Unpin, 

type Output = FloodsubRpc

type Error = FloodsubDecodeError

type Future = Pin<Box<dyn Future<Output = Result<<FloodsubProtocol as InboundUpgrade<TSocket>>::Output, <FloodsubProtocol as InboundUpgrade<TSocket>>::Error>> + Send + 'static, Global>>

impl<TSocket> InboundUpgrade<TSocket> for ProtocolConfig where
    TSocket: 'static + AsyncRead + AsyncWrite + Unpin + Send, 

type Output = (Framed<TSocket, GossipsubCodec>, PeerKind)

type Error = GossipsubHandlerError

type Future = Pin<Box<dyn Future<Output = Result<<ProtocolConfig as InboundUpgrade<TSocket>>::Output, <ProtocolConfig as InboundUpgrade<TSocket>>::Error>> + Send + 'static, Global>>