Struct libp2p_core::transport::upgrade::Authenticated
source · pub struct Authenticated<T>(/* private fields */);
Expand description
An transport with peer authentication, obtained from Builder::authenticate
.
Implementations§
source§impl<T> Authenticated<T>
impl<T> Authenticated<T>
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: InboundConnectionUpgrade<Negotiated<C>, Output = D, Error = E> + OutboundConnectionUpgrade<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: InboundConnectionUpgrade<Negotiated<C>, Output = D, Error = E> + OutboundConnectionUpgrade<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: InboundConnectionUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundConnectionUpgrade<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: InboundConnectionUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundConnectionUpgrade<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: InboundConnectionUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundConnectionUpgrade<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: InboundConnectionUpgrade<Negotiated<C>, Output = M, Error = E> + OutboundConnectionUpgrade<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 moreAuto Trait Implementations§
impl<T> Freeze for Authenticated<T>where
T: Freeze,
impl<T> RefUnwindSafe for Authenticated<T>where
T: RefUnwindSafe,
impl<T> Send for Authenticated<T>where
T: Send,
impl<T> Sync for Authenticated<T>where
T: Sync,
impl<T> Unpin for Authenticated<T>where
T: Unpin,
impl<T> UnwindSafe for Authenticated<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more