Struct libp2p::core::upgrade::OptionalUpgrade
source · 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§
source§impl<T> OptionalUpgrade<T>
impl<T> OptionalUpgrade<T>
sourcepub fn some(inner: T) -> OptionalUpgrade<T>
pub fn some(inner: T) -> OptionalUpgrade<T>
Creates an enabled OptionalUpgrade
.
sourcepub fn none() -> OptionalUpgrade<T>
pub fn none() -> OptionalUpgrade<T>
Creates a disabled OptionalUpgrade
.
Trait Implementations§
source§impl<T> Clone for OptionalUpgrade<T>where
T: Clone,
impl<T> Clone for OptionalUpgrade<T>where T: Clone,
source§fn clone(&self) -> OptionalUpgrade<T>
fn clone(&self) -> OptionalUpgrade<T>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T> Debug for OptionalUpgrade<T>where
T: Debug,
impl<T> Debug for OptionalUpgrade<T>where T: Debug,
source§impl<C, T> InboundUpgrade<C> for OptionalUpgrade<T>where
T: InboundUpgrade<C>,
impl<C, T> InboundUpgrade<C> for OptionalUpgrade<T>where T: InboundUpgrade<C>,
§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.
source§fn upgrade_inbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as InboundUpgrade<C>>::Future
fn upgrade_inbound( self, sock: C, info: <OptionalUpgrade<T> as UpgradeInfo>::Info ) -> <OptionalUpgrade<T> 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. Read more
source§impl<C, T> OutboundUpgrade<C> for OptionalUpgrade<T>where
T: OutboundUpgrade<C>,
impl<C, T> OutboundUpgrade<C> for OptionalUpgrade<T>where T: OutboundUpgrade<C>,
§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.
source§fn upgrade_outbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as OutboundUpgrade<C>>::Future
fn upgrade_outbound( self, sock: C, info: <OptionalUpgrade<T> as UpgradeInfo>::Info ) -> <OptionalUpgrade<T> 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. Read more
source§impl<T> UpgradeInfo for OptionalUpgrade<T>where
T: UpgradeInfo,
impl<T> UpgradeInfo for OptionalUpgrade<T>where T: UpgradeInfo,
§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
.source§fn protocol_info(&self) -> <OptionalUpgrade<T> as UpgradeInfo>::InfoIter
fn protocol_info(&self) -> <OptionalUpgrade<T> as UpgradeInfo>::InfoIter
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§
§impl<'a, T> AsTaggedExplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedExplicit<'a> for Twhere T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere T: 'a,
§impl<'a, T> AsTaggedImplicit<'a> for Twhere
T: 'a,
impl<'a, T> AsTaggedImplicit<'a> for Twhere T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere T: 'a,
source§impl<C, U> InboundUpgradeExt<C> for Uwhere
U: InboundUpgrade<C>,
impl<C, U> InboundUpgradeExt<C> for Uwhere U: InboundUpgrade<C>,
source§fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F>where
Self: Sized,
F: FnOnce(Self::Output) -> T,
fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F>where Self: Sized, F: FnOnce(Self::Output) -> T,
Returns a new object that wraps around
Self
and applies a closure to the Output
.source§fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>where
Self: Sized,
F: FnOnce(Self::Error) -> T,
fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> T,
Returns a new object that wraps around
Self
and applies a closure to the Error
.source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
source§impl<C, U> OutboundUpgradeExt<C> for Uwhere
U: OutboundUpgrade<C>,
impl<C, U> OutboundUpgradeExt<C> for Uwhere U: OutboundUpgrade<C>,
source§fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F>where
Self: Sized,
F: FnOnce(Self::Output) -> T,
fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F>where Self: Sized, F: FnOnce(Self::Output) -> T,
Returns a new object that wraps around
Self
and applies a closure to the Output
.source§fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>where
Self: Sized,
F: FnOnce(Self::Error) -> T,
fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F>where Self: Sized, F: FnOnce(Self::Error) -> T,
Returns a new object that wraps around
Self
and applies a closure to the Error
.