Struct libp2p::core::transport::upgrade::Upgrade

[+] Show declaration

pub struct Upgrade<T, U> { /* fields omitted */ }

[−] Expand description

A custom upgrade on an Authenticated transport.

See Transport::upgrade

Implementations

impl<T, U> Upgrade<T, U>[−]

pub fn new(inner: T, upgrade: U) -> Upgrade<T, U>

Trait Implementations

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

[+] Show hidden undocumented items

pub fn clone(&self) -> Upgrade<T, U>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, U> Copy for Upgrade<T, U> where
    T: Copy,
    U: Copy, 

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<T, C, D, U, E> Transport for Upgrade<T, U> where
    C: AsyncRead + AsyncWrite + Unpin,
    E: Error + 'static,
    T: Transport<Output = (PeerId, C)>,
    U: InboundUpgrade<Negotiated<C>, Output = D, Error = E> + OutboundUpgrade<Negotiated<C>, Output = D, Error = E> + Clone,
    <T as Transport>::Error: 'static, [+]

[+] Show hidden undocumented items

type Output = (PeerId, D)

The result of a connection setup process, including protocol upgrades.

type Error = TransportUpgradeError<<T as Transport>::Error, E>

An error that occurred during connection setup.

type Listener = ListenerStream<<T as Transport>::Listener, U>

A stream of Outputs for inbound connections.

type ListenerUpgrade = ListenerUpgradeFuture<<T as Transport>::ListenerUpgrade, U, C>

A pending Output for an inbound connection, obtained from the Listener stream.

type Dial = DialUpgradeFuture<<T as Transport>::Dial, U, C>

A pending Output for an outbound connection, obtained from dialing.

pub fn dial(
    self,
    addr: Multiaddr
) -> Result<<Upgrade<T, U> as Transport>::Dial, TransportError<<Upgrade<T, U> as Transport>::Error>>[−]

Dials the given Multiaddr, returning a future for a pending outbound connection.

pub fn listen_on(
    self,
    addr: Multiaddr
) -> Result<<Upgrade<T, U> as Transport>::Listener, TransportError<<Upgrade<T, U> as Transport>::Error>>[−]

Listens on the given Multiaddr, producing a stream of pending, inbound connections and addresses this transport is listening on (cf. ListenerEvent).

pub fn address_translation(
    &self,
    server: &Multiaddr,
    observed: &Multiaddr
) -> Option<Multiaddr>[−]

Performs a transport-specific mapping of an address observed by a remote onto a local listen address to yield an address for the local node that may be reachable for other peers.

pub fn boxed(self) -> Boxed<Self::Output> where
    Self: Transport + Clone + Send + Sync + 'static,
    Self::Dial: Send,
    Self::Dial: 'static,
    Self::Listener: Send,
    Self::Listener: 'static,
    Self::ListenerUpgrade: Send,
    Self::ListenerUpgrade: 'static,
    Self::Error: Send,
    Self::Error: Sync, [−]

Boxes the transport, including custom transport errors.

pub fn map<F, O>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone, [−]

Applies a function on the connections created by the transport.

pub fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> E + Clone, [−]

Applies a function on the errors generated by the futures of the transport.

pub fn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
    U: Transport,
    <U as Transport>::Error: 'static, [−]

Adds a fallback transport that is used when encountering errors while establishing inbound or outbound connections.

pub fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C> where
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error,
    <F as TryFuture>::Error: 'static, [−]

Applies a function producing an asynchronous result to every connection created by this transport.

pub fn upgrade(self, version: Version) -> Builder<Self> where
    Self::Error: 'static, [−]

Begins a series of protocol upgrades via an upgrade::Builder.