Struct libp2p::core::nodes::collection::CollectionReachEvent

#[must_use = "The node reached event is used to accept the newly-opened connection"]
pub struct CollectionReachEvent<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo = PeerId, TPeerId = PeerId> { /* fields omitted */ }

Event that happens when we reach a node.

Methods

impl<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> CollectionReachEvent<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId>

pub fn connection_info(&self) -> &TConnInfo

Returns the information of the connection.

pub fn peer_id(&self) -> &TPeerId where
    TConnInfo: ConnectionInfo<PeerId = TPeerId>,
    TPeerId: Eq + Hash, 

Returns the identity of the node we connected to.

pub fn reach_attempt_id(&self) -> ReachAttemptId

Returns the reach attempt that reached the node.

impl<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> CollectionReachEvent<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> where
    TConnInfo: ConnectionInfo<PeerId = TPeerId>,
    TPeerId: Eq + Hash, 

pub fn would_replace(&self) -> bool

Returns true if accepting this reached node would replace an existing connection to that node.

pub fn accept(
    self,
    user_data: TUserData
) -> (CollectionNodeAccept<TConnInfo, TUserData>, TConnInfo) where
    TConnInfo: Clone,
    TPeerId: Clone, 

Accepts the new node.

pub fn deny(self) -> TConnInfo

Denies the node.

Has the same effect as dropping the event without accepting it.

Trait Implementations

impl<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> Debug for CollectionReachEvent<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> where
    TConnInfo: Debug, 

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

Formats the value using the given formatter.

impl<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId> Drop for CollectionReachEvent<'a, TInEvent, TOutEvent, THandler, TReachErr, THandlerErr, TUserData, TConnInfo, TPeerId>

fn drop(&mut self)

Executes the destructor for this type.