Struct libp2p::core::upgrade::OptionalUpgrade [−][src]
pub struct OptionalUpgrade<T>(_);
Expand description
Upgrade that can be disabled at runtime.
Wraps around an Option<T>
and makes it available or not depending on whether it contains or
not an upgrade.
Implementations
Creates an enabled OptionalUpgrade
.
Creates a disabled OptionalUpgrade
.
Trait Implementations
type Output = <T as InboundUpgrade<C>>::Output
type Output = <T as InboundUpgrade<C>>::Output
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = <T as InboundUpgrade<C>>::Error
type Error = <T as InboundUpgrade<C>>::Error
Possible error during the handshake.
type Future = <T as InboundUpgrade<C>>::Future
type Future = <T as InboundUpgrade<C>>::Future
Future that performs the handshake with the remote.
pub fn upgrade_inbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as InboundUpgrade<C>>::Future
[src]
pub fn upgrade_inbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as InboundUpgrade<C>>::Future
[src]After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
type Output = <T as OutboundUpgrade<C>>::Output
type Output = <T as OutboundUpgrade<C>>::Output
Output after the upgrade has been successfully negotiated and the handshake performed.
type Error = <T as OutboundUpgrade<C>>::Error
type Error = <T as OutboundUpgrade<C>>::Error
Possible error during the handshake.
type Future = <T as OutboundUpgrade<C>>::Future
type Future = <T as OutboundUpgrade<C>>::Future
Future that performs the handshake with the remote.
pub fn upgrade_outbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as OutboundUpgrade<C>>::Future
[src]
pub fn upgrade_outbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as OutboundUpgrade<C>>::Future
[src]After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more
type Info = <T as UpgradeInfo>::Info
type Info = <T as UpgradeInfo>::Info
Opaque type representing a negotiable protocol.
type InfoIter = Iter<<<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter>
type InfoIter = Iter<<<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter>
Iterator returned by protocol_info
.
Returns the list of protocols that are supported. Used during the negotiation process.
Auto Trait Implementations
impl<T> RefUnwindSafe for OptionalUpgrade<T> where
T: RefUnwindSafe,
impl<T> Send for OptionalUpgrade<T> where
T: Send,
impl<T> Sync for OptionalUpgrade<T> where
T: Sync,
impl<T> Unpin for OptionalUpgrade<T> where
T: Unpin,
impl<T> UnwindSafe for OptionalUpgrade<T> where
T: UnwindSafe,
Blanket Implementations
Mutably borrows from an owned value. Read more
fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
[src]
fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
[src]Returns a new object that wraps around Self
and applies a closure to the Output
.
fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
[src]
fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
[src]Returns a new object that wraps around Self
and applies a closure to the Error
.
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
[src]
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,
[src]Returns a new object that wraps around Self
and applies a closure to the Output
.
fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
[src]
fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,
[src]Returns a new object that wraps around Self
and applies a closure to the Error
.
pub fn vzip(self) -> V