Struct libp2p_core::transport::upgrade::Upgrade

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

A custom upgrade on an Authenticated transport.

See Transport::upgrade

Implementations

impl<T, U> Upgrade<T, U>

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

Trait Implementations

impl<T: Clone, U: Clone> Clone for Upgrade<T, U>

fn clone(&self) -> Upgrade<T, U>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, U: Debug> Debug for Upgrade<T, U>

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

Formats the value using the given formatter.

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

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 ListenerUpgrade = ListenerUpgradeFuture<<T as Transport>::ListenerUpgrade, U, C>

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

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

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

fn dial(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

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

fn remove_listener(&mut self, id: ListenerId) -> bool

Remove a listener.

fn dial_as_listener(
    &mut self,
    addr: Multiaddr
) -> Result<Self::Dial, TransportError<Self::Error>>

As Transport::dial but has the local node act as a listener on the outgoing connection.

fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<Self::Error>>

Listens on the given Multiaddr for inbound connections.

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.

fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>

Poll for TransportEvents.

fn map<F, O>(self, f: F) -> Map<Self, F>where
    Self: Sized,
    F: FnOnce(Self::Output, ConnectedPoint) -> O,

Applies a function on the connections created by the transport.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>where
    Self: Sized,
    F: FnOnce(Self::Error) -> E,

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

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

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

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

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

fn upgrade(self, version: Version) -> Builder<Self>where
    Self: Sized,
    Self::Error: 'static,

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

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

impl<'pin, T, U> Unpin for Upgrade<T, U>where
    __Upgrade<'pin, T, U>: Unpin,