Struct libp2p::request_response::handler::RequestProtocol
source · [−]pub struct RequestProtocol<TCodec> where
TCodec: RequestResponseCodec, { /* private fields */ }Expand description
Request substream upgrade protocol.
Sends a request and receives a response.
Trait Implementations
sourceimpl<TCodec> Debug for RequestProtocol<TCodec> where
TCodec: Debug + RequestResponseCodec,
<TCodec as RequestResponseCodec>::Protocol: Debug,
<TCodec as RequestResponseCodec>::Request: Debug,
impl<TCodec> Debug for RequestProtocol<TCodec> where
TCodec: Debug + RequestResponseCodec,
<TCodec as RequestResponseCodec>::Protocol: Debug,
<TCodec as RequestResponseCodec>::Request: Debug,
sourceimpl<TCodec> OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for RequestProtocol<TCodec> where
TCodec: 'static + RequestResponseCodec + Send,
impl<TCodec> OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>> for RequestProtocol<TCodec> where
TCodec: 'static + RequestResponseCodec + Send,
type Output = <TCodec as RequestResponseCodec>::Response
type Output = <TCodec as RequestResponseCodec>::Response
Output after the upgrade has been successfully negotiated and the handshake performed.
type Future = Pin<Box<dyn Future<Output = Result<<RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>> + Send + 'static, Global>>
type Future = Pin<Box<dyn Future<Output = Result<<RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Output, <RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Error>> + Send + 'static, Global>>
Future that performs the handshake with the remote.
sourcepub fn upgrade_outbound(
self,
io: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
protocol: <RequestProtocol<TCodec> as UpgradeInfo>::Info
) -> <RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future
pub fn upgrade_outbound(
self,
io: Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>,
protocol: <RequestProtocol<TCodec> as UpgradeInfo>::Info
) -> <RequestProtocol<TCodec> as OutboundUpgrade<Negotiated<SubstreamRef<Arc<StreamMuxerBox>>>>>::Future
After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
sourceimpl<TCodec> UpgradeInfo for RequestProtocol<TCodec> where
TCodec: RequestResponseCodec,
impl<TCodec> UpgradeInfo for RequestProtocol<TCodec> where
TCodec: RequestResponseCodec,
type Info = <TCodec as RequestResponseCodec>::Protocol
type Info = <TCodec as RequestResponseCodec>::Protocol
Opaque type representing a negotiable protocol.
type InfoIter = IntoIter<[<RequestProtocol<TCodec> as UpgradeInfo>::Info; 2]>
type InfoIter = IntoIter<[<RequestProtocol<TCodec> as UpgradeInfo>::Info; 2]>
Iterator returned by protocol_info.
sourcepub fn protocol_info(
&self
) -> <RequestProtocol<TCodec> as UpgradeInfo>::InfoIter
pub fn protocol_info(
&self
) -> <RequestProtocol<TCodec> as UpgradeInfo>::InfoIter
Returns the list of protocols that are supported. Used during the negotiation process.
Auto Trait Implementations
impl<TCodec> RefUnwindSafe for RequestProtocol<TCodec> where
TCodec: RefUnwindSafe,
<TCodec as RequestResponseCodec>::Protocol: RefUnwindSafe,
<TCodec as RequestResponseCodec>::Request: RefUnwindSafe,
impl<TCodec> Send for RequestProtocol<TCodec> where
TCodec: Send,
impl<TCodec> Sync for RequestProtocol<TCodec> where
TCodec: Sync,
<TCodec as RequestResponseCodec>::Protocol: Sync,
<TCodec as RequestResponseCodec>::Request: Sync,
impl<TCodec> Unpin for RequestProtocol<TCodec> where
TCodec: Unpin,
<TCodec as RequestResponseCodec>::Protocol: Unpin,
<TCodec as RequestResponseCodec>::Request: Unpin,
impl<TCodec> UnwindSafe for RequestProtocol<TCodec> where
TCodec: UnwindSafe,
<TCodec as RequestResponseCodec>::Protocol: UnwindSafe + RefUnwindSafe,
<TCodec as RequestResponseCodec>::Request: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
impl<C, U> OutboundUpgradeExt<C> for U where
U: OutboundUpgrade<C>,
sourcefn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
Returns a new object that wraps around Self and applies a closure to the Output.
sourcefn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
Returns a new object that wraps around Self and applies a closure to the Error.