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

impl<T> OptionalUpgrade<T>[src]

pub fn some(inner: T) -> OptionalUpgrade<T>[src]

Creates an enabled OptionalUpgrade.

pub fn none() -> OptionalUpgrade<T>[src]

Creates a disabled OptionalUpgrade.

Trait Implementations

impl<T> Clone for OptionalUpgrade<T> where
    T: Clone,

[src]

pub fn clone(&self) -> OptionalUpgrade<T>[src]

Returns a copy of the value. Read more

fn clone_from(&mut self, source: &Self)1.0.0 [src]

Performs copy-assignment from source. Read more

impl<T> Debug for OptionalUpgrade<T> where
    T: Debug,

[src]

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

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

[src]

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

Possible error during the handshake.

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]

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

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

[src]

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

Possible error during the handshake.

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]

After we have determined that the remote supports one of the protocols we support, this method is called to start the handshake. Read more

impl<T> UpgradeInfo for OptionalUpgrade<T> where
    T: UpgradeInfo,

[src]

type Info = <T as UpgradeInfo>::Info

Opaque type representing a negotiable protocol.

type InfoIter = Iter<<<T as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter>

Iterator returned by protocol_info.

pub fn protocol_info(&self) -> <OptionalUpgrade<T> as UpgradeInfo>::InfoIter[src]

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<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<C, U> InboundUpgradeExt<C> for U where
    U: InboundUpgrade<C>,

[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]

Returns a new object that wraps around Self and applies a closure to the Error.

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<C, U> OutboundUpgradeExt<C> for U where
    U: OutboundUpgrade<C>,

[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]

Returns a new object that wraps around Self and applies a closure to the Error.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T> ToOwned for T where
    T: Clone,

[src]

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

[src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V