Struct libp2p_core::network::peer::DialingPeer

pub struct DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
    TTrans: Transport,
    THandler: IntoConnectionHandler,  { /* private fields */ }

The representation of a peer in a Network to whom a dialing attempt is ongoing. There may already exist other established connections to this peer.

Implementations

impl<'a, TTrans, TInEvent, TOutEvent, THandler> DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
    TTrans: Transport,
    THandler: IntoConnectionHandler, 

pub fn id(&self) -> &PeerId

pub fn into_peer(self) -> Peer<'a, TTrans, TInEvent, TOutEvent, THandler>

Returns the DialingPeer into a Peer.

pub fn disconnect(
    self
) -> DisconnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>

Disconnects from this peer, closing all established connections and aborting all dialing attempts.

pub fn is_connected(&self) -> bool

Checks whether there is an established connection to the peer.

Returns true iff DialingPeer::into_connected returns Some.

pub fn into_connected(
    self
) -> Option<ConnectedPeer<'a, TTrans, TInEvent, TOutEvent, THandler>>

Converts the peer into a ConnectedPeer, if an established connection exists.

pub fn attempt(
    &mut self,
    id: ConnectionId
) -> Option<DialingAttempt<'_, TInEvent>>

Obtains a dialing attempt to the peer by connection ID of the current connection attempt.

pub fn attempts(
    &mut self
) -> DialingAttemptIter<'_, TInEvent, TOutEvent, THandler, TTrans::Error, <THandler::Handler as ConnectionHandler>::Error>

Gets an iterator over all dialing (i.e. pending outgoing) connections to the peer.

pub fn some_attempt(&mut self) -> DialingAttempt<'_, TInEvent>

Obtains some dialing connection to the peer.

At least one dialing connection is guaranteed to exist on a DialingPeer.

Trait Implementations

impl<'a, TTrans, TInEvent, TOutEvent, THandler> Debug for DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler> where
    TTrans: Transport,
    THandler: IntoConnectionHandler, 

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

Formats the value using the given formatter.