Struct libp2p_core::upgrade::SelectUpgrade

pub struct SelectUpgrade<A, B>(/* private fields */);

Upgrade that combines two upgrades into one. Supports all the protocols supported by either sub-upgrade.

The protocols supported by the first element have a higher priority.

Implementations

impl<A, B> SelectUpgrade<A, B>

pub fn new(a: A, b: B) -> Self

Combines two upgrades into an SelectUpgrade.

The protocols supported by the first element have a higher priority.

Trait Implementations

impl<A: Clone, B: Clone> Clone for SelectUpgrade<A, B>

fn clone(&self) -> SelectUpgrade<A, B>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, B: Debug> Debug for SelectUpgrade<A, B>

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

Formats the value using the given formatter.

impl<C, A, B, TA, TB, EA, EB> InboundConnectionUpgrade<C> for SelectUpgrade<A, B>

where A: InboundConnectionUpgrade<C, Output = TA, Error = EA>, B: InboundConnectionUpgrade<C, Output = TB, Error = EB>,

type Output = Either<TA, TB>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Either<EA, EB>

Possible error during the handshake.

type Future = EitherFuture<<A as InboundConnectionUpgrade<C>>::Future, <B as InboundConnectionUpgrade<C>>::Future>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, sock: C, info: Self::Info) -> Self::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, A, B, TA, TB, EA, EB> InboundUpgrade<C> for SelectUpgrade<A, B>

where A: InboundUpgrade<C, Output = TA, Error = EA>, B: InboundUpgrade<C, Output = TB, Error = EB>,

type Output = Either<TA, TB>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Either<EA, EB>

Possible error during the handshake.

type Future = EitherFuture<<A as InboundUpgrade<C>>::Future, <B as InboundUpgrade<C>>::Future>

Future that performs the handshake with the remote.

fn upgrade_inbound(self, sock: C, info: Self::Info) -> Self::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, A, B, TA, TB, EA, EB> OutboundConnectionUpgrade<C> for SelectUpgrade<A, B>

where A: OutboundConnectionUpgrade<C, Output = TA, Error = EA>, B: OutboundConnectionUpgrade<C, Output = TB, Error = EB>,

type Output = Either<TA, TB>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Either<EA, EB>

Possible error during the handshake.

type Future = EitherFuture<<A as OutboundConnectionUpgrade<C>>::Future, <B as OutboundConnectionUpgrade<C>>::Future>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, sock: C, info: Self::Info) -> Self::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, A, B, TA, TB, EA, EB> OutboundUpgrade<C> for SelectUpgrade<A, B>

where A: OutboundUpgrade<C, Output = TA, Error = EA>, B: OutboundUpgrade<C, Output = TB, Error = EB>,

type Output = Either<TA, TB>

Output after the upgrade has been successfully negotiated and the handshake performed.

type Error = Either<EA, EB>

Possible error during the handshake.

type Future = EitherFuture<<A as OutboundUpgrade<C>>::Future, <B as OutboundUpgrade<C>>::Future>

Future that performs the handshake with the remote.

fn upgrade_outbound(self, sock: C, info: Self::Info) -> Self::Future

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

impl<A, B> UpgradeInfo for SelectUpgrade<A, B>

where A: UpgradeInfo, B: UpgradeInfo,

type Info = Either<<A as UpgradeInfo>::Info, <B as UpgradeInfo>::Info>

Opaque type representing a negotiable protocol.

type InfoIter = Chain<Map<<<A as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter, fn(_: <A as UpgradeInfo>::Info) -> <SelectUpgrade<A, B> as UpgradeInfo>::Info>, Map<<<B as UpgradeInfo>::InfoIter as IntoIterator>::IntoIter, fn(_: <B as UpgradeInfo>::Info) -> <SelectUpgrade<A, B> as UpgradeInfo>::Info>>

Iterator returned by protocol_info.

fn protocol_info(&self) -> Self::InfoIter

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