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§
Source§impl<'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> Freeze for ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>
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>
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§
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
Mutably borrows from an owned value. Read more
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>
Converts
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>
Converts
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