Struct libp2p_core::transport::upgrade::Authenticated
source · pub struct Authenticated<T>(_);
Expand description
An transport with peer authentication, obtained from Builder::authenticate
.
Implementations§
source§impl<T> Authenticated<T>where
T: Transport,
T::Error: 'static,
impl<T> Authenticated<T>where T: Transport, T::Error: 'static,
sourcepub fn apply<C, D, U, E>(self, upgrade: U) -> Authenticated<Upgrade<T, U>>where
T: Transport<Output = (PeerId, C)>,
C: AsyncRead + AsyncWrite + Unpin,
D: AsyncRead + AsyncWrite + Unpin,
U: InboundUpgrade<Negotiated<C>, Output = D, Error = E> + OutboundUpgrade<Negotiated<C>, Output = D, Error = E> + Clone,
E: Error + 'static,
pub fn apply<C, D, U, E>(self, upgrade: U) -> Authenticated<Upgrade<T, U>>where T: Transport<Output = (PeerId, C)>, C: AsyncRead + AsyncWrite + Unpin, D: AsyncRead + AsyncWrite + Unpin, U: InboundUpgrade<Negotiated<C>, Output = D, Error = E> + OutboundUpgrade<Negotiated<C>, Output = D, Error = E> + Clone, E: Error + 'static,
Applies an arbitrary upgrade.
The upgrade receives the I/O resource (i.e. connection) C
and
must produce a new I/O resource D
. Any number of such upgrades
can be performed.
Transitions
- I/O upgrade:
C -> D
. - Transport output:
(PeerId, C) -> (PeerId, D)
.
sourcepub fn multiplex<C, M, U, E>(
self,
upgrade: U
) -> Multiplexed<AndThen<T, impl FnOnce((PeerId, C), ConnectedPoint) -> Multiplex<C, U> + Clone>>where
T: Transport<Output = (PeerId, C)>,
C: AsyncRead + AsyncWrite + Unpin,
M: StreamMuxer,
U: InboundUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundUpgrade<Negotiated<C>, Output = M, Error = E> + Clone,
E: Error + 'static,
pub fn multiplex<C, M, U, E>( self, upgrade: U ) -> Multiplexed<AndThen<T, impl FnOnce((PeerId, C), ConnectedPoint) -> Multiplex<C, U> + Clone>>where T: Transport<Output = (PeerId, C)>, C: AsyncRead + AsyncWrite + Unpin, M: StreamMuxer, U: InboundUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundUpgrade<Negotiated<C>, Output = M, Error = E> + Clone, E: Error + 'static,
Upgrades the transport with a (sub)stream multiplexer.
The supplied upgrade receives the I/O resource C
and must
produce a StreamMuxer
M
. The transport must already be authenticated.
This ends the (regular) transport upgrade process.
Transitions
- I/O upgrade:
C -> M
. - Transport output:
(PeerId, C) -> (PeerId, M)
.
sourcepub fn multiplex_ext<C, M, U, E, F>(
self,
up: F
) -> Multiplexed<AndThen<T, impl FnOnce((PeerId, C), ConnectedPoint) -> Multiplex<C, U> + Clone>>where
T: Transport<Output = (PeerId, C)>,
C: AsyncRead + AsyncWrite + Unpin,
M: StreamMuxer,
U: InboundUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundUpgrade<Negotiated<C>, Output = M, Error = E> + Clone,
E: Error + 'static,
F: for<'a> FnOnce(&'a PeerId, &'a ConnectedPoint) -> U + Clone,
pub fn multiplex_ext<C, M, U, E, F>( self, up: F ) -> Multiplexed<AndThen<T, impl FnOnce((PeerId, C), ConnectedPoint) -> Multiplex<C, U> + Clone>>where T: Transport<Output = (PeerId, C)>, C: AsyncRead + AsyncWrite + Unpin, M: StreamMuxer, U: InboundUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundUpgrade<Negotiated<C>, Output = M, Error = E> + Clone, E: Error + 'static, F: for<'a> FnOnce(&'a PeerId, &'a ConnectedPoint) -> U + Clone,
Like Authenticated::multiplex
but accepts a function which returns the upgrade.
The supplied function is applied to PeerId
and ConnectedPoint
and returns an upgrade which receives the I/O resource C
and must
produce a StreamMuxer
M
. The transport must already be authenticated.
This ends the (regular) transport upgrade process.
Transitions
- I/O upgrade:
C -> M
. - Transport output:
(PeerId, C) -> (PeerId, M)
.
Trait Implementations§
source§impl<T: Clone> Clone for Authenticated<T>
impl<T: Clone> Clone for Authenticated<T>
source§fn clone(&self) -> Authenticated<T>
fn clone(&self) -> Authenticated<T>
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more