Enum libp2p_swarm::handler::ConnectionHandlerEvent

#[non_exhaustive]
pub enum ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom> {
    OutboundSubstreamRequest {
        protocol: SubstreamProtocol<TConnectionUpgrade, TOutboundOpenInfo>,
    },
    ReportRemoteProtocols(ProtocolSupport),
    NotifyBehaviour(TCustom),
}

Event produced by a handler.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

OutboundSubstreamRequest

Request a new outbound substream to be opened with the remote.

Fields

protocol: SubstreamProtocol<TConnectionUpgrade, TOutboundOpenInfo>

The protocol(s) to apply on the substream.

ReportRemoteProtocols(ProtocolSupport)

We learned something about the protocols supported by the remote.

NotifyBehaviour(TCustom)

Event that is sent to a NetworkBehaviour.

Implementations

impl<TConnectionUpgrade, TOutboundOpenInfo, TCustom> ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

Event produced by a handler.

pub fn map_outbound_open_info<F, I>( self, map: F, ) -> ConnectionHandlerEvent<TConnectionUpgrade, I, TCustom>

where F: FnOnce(TOutboundOpenInfo) -> I,

If this is an OutboundSubstreamRequest, maps the info member from a TOutboundOpenInfo to something else.

pub fn map_protocol<F, I>( self, map: F, ) -> ConnectionHandlerEvent<I, TOutboundOpenInfo, TCustom>

where F: FnOnce(TConnectionUpgrade) -> I,

If this is an OutboundSubstreamRequest, maps the protocol (TConnectionUpgrade) to something else.

pub fn map_custom<F, I>( self, map: F, ) -> ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, I>

where F: FnOnce(TCustom) -> I,

If this is a Custom event, maps the content to something else.

Trait Implementations

impl<TConnectionUpgrade: Clone, TOutboundOpenInfo: Clone, TCustom: Clone> Clone for ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

fn clone( &self, ) -> ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<TConnectionUpgrade: Debug, TOutboundOpenInfo: Debug, TCustom: Debug> Debug for ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

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

Formats the value using the given formatter.

impl<TConnectionUpgrade: PartialEq, TOutboundOpenInfo: PartialEq, TCustom: PartialEq> PartialEq for ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

fn eq( &self, other: &ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>, ) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<TConnectionUpgrade: Eq, TOutboundOpenInfo: Eq, TCustom: Eq> Eq for ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

impl<TConnectionUpgrade, TOutboundOpenInfo, TCustom> StructuralPartialEq for ConnectionHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>