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>

source

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

Creates an enabled OptionalUpgrade.

source

pub fn none() -> OptionalUpgrade<T>

Creates a disabled OptionalUpgrade.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

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.

source

pub 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>,

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.

source

pub 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,

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.

source

pub 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

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

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

source

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
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
F: FnOnce(Self::Error) -> T,

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

source

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

source

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.

source

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.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

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

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

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

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

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

source

Struct libp2p::core::upgrade::OptionalUpgrade

Implementations

impl<T> OptionalUpgrade<T>

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

pub fn none() -> OptionalUpgrade<T>

Trait Implementations

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

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

fn clone_from(&mut self, source: &Self)

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

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

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

pub fn upgrade_inbound( self, sock: C, info: <OptionalUpgrade<T> as UpgradeInfo>::Info) -> <OptionalUpgrade<T> as InboundUpgrade<C>>::Future

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

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

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

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

pub fn upgrade_outbound( self, sock: C, info: <OptionalUpgrade<T> as UpgradeInfo>::Info) -> <OptionalUpgrade<T> as OutboundUpgrade<C>>::Future

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

type Info = <T as UpgradeInfo>::Info

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

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

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,

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

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

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where F: FnOnce(Self::Output) -> T,

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where F: FnOnce(Self::Error) -> T,

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

pub fn into(self) -> U

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

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where F: FnOnce(Self::Error) -> T,

impl<T> Same<T> for T

type Output = T

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

pub fn vzip(self) -> V

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

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

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

pub fn upgrade_inbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as InboundUpgrade<C>>::Future

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

pub fn upgrade_outbound(
self,
sock: C,
info: <OptionalUpgrade<T> as UpgradeInfo>::Info
) -> <OptionalUpgrade<T> as OutboundUpgrade<C>>::Future

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

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,

impl<T> Any for T where
T: 'static + ?Sized,

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

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

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

fn map_inbound<F, T>(self, f: F) -> MapInboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

fn map_inbound_err<F, T>(self, f: F) -> MapInboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

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

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

fn map_outbound<F, T>(self, f: F) -> MapOutboundUpgrade<Self, F> where
F: FnOnce(Self::Output) -> T,

fn map_outbound_err<F, T>(self, f: F) -> MapOutboundUpgradeErr<Self, F> where
F: FnOnce(Self::Error) -> T,

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

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

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

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