Struct libp2p::core::upgrade::OptionalUpgrade

[+] Show declaration

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

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

Creates an enabled OptionalUpgrade.

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

Creates a disabled OptionalUpgrade.

Trait Implementations

impl<T> Clone for OptionalUpgrade<T> where
    T: Clone, [+]

[+] Show hidden undocumented items

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

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T> Debug for OptionalUpgrade<T> where
    T: Debug, [+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<C, T> InboundUpgrade<C> for OptionalUpgrade<T> where
    T: InboundUpgrade<C>, [+]

[+] Show hidden undocumented items

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

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

impl<C, T> OutboundUpgrade<C> for OptionalUpgrade<T> where
    T: OutboundUpgrade<C>, [+]

[+] Show hidden undocumented items

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

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

impl<T> UpgradeInfo for OptionalUpgrade<T> where
    T: UpgradeInfo, [+]

[+] Show hidden undocumented items

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

Returns the list of protocols that are supported. Used during the negotiation process.