Struct libp2p::core::network::peer::DialingPeer

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

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, TConnInfo, TPeerId> DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> where
    TConnInfo: ConnectionInfo<PeerId = TPeerId>,
    THandler: IntoConnectionHandler<TConnInfo>,
    TPeerId: Eq + Hash + Clone,
    TTrans: Transport, 

pub fn id(&self) -> &TPeerId

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

Returns the DialingPeer into a Peer.

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

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, TConnInfo, TPeerId>>

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

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

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

pub fn num_attempts(&self) -> usize

The number of ongoing dialing attempts, i.e. pending outgoing connections to this peer.

pub fn attempts(
    &'b mut self
) -> DialingAttemptIter<'b, TInEvent, TOutEvent, THandler, <TTrans as Transport>::Error, <<THandler as IntoConnectionHandler<TConnInfo>>::Handler as ConnectionHandler>::Error, TConnInfo, TPeerId>

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

pub fn some_attempt(
    &'b mut self
) -> DialingAttempt<'b, TInEvent, TConnInfo, TPeerId>

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, TConnInfo, TPeerId> Debug for DialingPeer<'a, TTrans, TInEvent, TOutEvent, THandler, TConnInfo, TPeerId> where
    THandler: IntoConnectionHandler<TConnInfo>,
    TPeerId: Eq + Hash + Debug,
    TTrans: Transport, 

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

Formats the value using the given formatter.