Struct libp2p_core::network::peer::ConnectedPeer
source · [−]pub struct ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
TTrans: Transport,
THandler: IntoConnectionHandler, { /* private fields */ }Expand description
The representation of a peer in a Network to whom at least
one established connection exists. There may also be additional ongoing
dialing attempts to the peer.
Implementations
sourceimpl<'a, TTrans, TInEvent, TOutEvent, THandler> ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
TTrans: Transport,
THandler: IntoConnectionHandler,
impl<'a, TTrans, TInEvent, TOutEvent, THandler> ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
TTrans: Transport,
THandler: IntoConnectionHandler,
pub fn id(&self) -> &PeerId
sourcepub fn into_peer(self) -> Peer<'a, TTrans, TInEvent, TOutEvent, THandler>
pub fn into_peer(self) -> Peer<'a, TTrans, TInEvent, TOutEvent, THandler>
Returns the ConnectedPeer into a Peer.
sourcepub fn connection(
&mut self,
id: ConnectionId
) -> Option<EstablishedConnection<'_, TInEvent>>
pub fn connection(
&mut self,
id: ConnectionId
) -> Option<EstablishedConnection<'_, TInEvent>>
Obtains an established connection to the peer by ID.
sourcepub fn num_connections(&self) -> u32
pub fn num_connections(&self) -> u32
The number of established connections to the peer.
sourcepub fn is_dialing(&self) -> bool
pub fn is_dialing(&self) -> bool
Checks whether there is an ongoing dialing attempt to the peer.
Returns true iff ConnectedPeer::into_dialing returns Some.
sourcepub fn into_dialing(
self
) -> Option<DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler>>
pub fn into_dialing(
self
) -> Option<DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler>>
Converts this peer into a DialingPeer, if there is an ongoing
dialing attempt, None otherwise.
sourcepub fn connections(
&mut self
) -> EstablishedConnectionIter<'_, impl Iterator<Item = ConnectionId>, TInEvent, TOutEvent, THandler, TTrans::Error, <THandler::Handler as ConnectionHandler>::Error>
pub fn connections(
&mut self
) -> EstablishedConnectionIter<'_, impl Iterator<Item = ConnectionId>, TInEvent, TOutEvent, THandler, TTrans::Error, <THandler::Handler as ConnectionHandler>::Error>
Gets an iterator over all established connections to the peer.
sourcepub fn some_connection(&mut self) -> EstablishedConnection<'_, TInEvent>
pub fn some_connection(&mut self) -> EstablishedConnection<'_, TInEvent>
Obtains some established connection to the peer.
sourcepub fn disconnect(
self
) -> DisconnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
pub fn disconnect(
self
) -> DisconnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
Disconnects from the peer, closing all connections.
Trait Implementations
Auto Trait Implementations
impl<'a, TTrans, TInEvent, TOutEvent, THandler> !RefUnwindSafe for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
impl<'a, TTrans, TInEvent, TOutEvent, THandler> Send for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
THandler: Send,
TInEvent: Send,
TOutEvent: Send,
TTrans: Send,
<TTrans as Transport>::Error: Send,
<<THandler as IntoConnectionHandler>::Handler as ConnectionHandler>::Error: Send,
<TTrans as Transport>::Listener: Send,
impl<'a, TTrans, TInEvent, TOutEvent, THandler> !Sync for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
impl<'a, TTrans, TInEvent, TOutEvent, THandler> Unpin for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
impl<'a, TTrans, TInEvent, TOutEvent, THandler> !UnwindSafe for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more