Enum libp2p_core::protocols_handler::ProtocolsHandlerEvent

pub enum ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom> {
    OutboundSubstreamRequest {
        upgrade: TConnectionUpgrade,
        info: TOutboundOpenInfo,
    },
    Shutdown,
    Custom(TCustom),
}

Event produced by a handler.

Variants

OutboundSubstreamRequest

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

Fields of OutboundSubstreamRequest

upgrade: TConnectionUpgrade

The upgrade to apply on the substream.

info: TOutboundOpenInfo

User-defined information, passed back when the substream is open.

Shutdown

Perform a graceful shutdown of the connection to the remote.

Should be returned after shutdown() has been called.

Custom(TCustom)

Other event.

Methods

impl<TConnectionUpgrade, TOutboundOpenInfo, TCustom> ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

Event produced by a handler.

pub fn map_outbound_open_info<F, I>(
    self,
    map: F
) -> ProtocolsHandlerEvent<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
) -> ProtocolsHandlerEvent<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
) -> ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, I> where
    F: FnOnce(TCustom) -> I, 

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

Trait Implementations

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TConnectionUpgrade: Copy, TOutboundOpenInfo: Copy, TCustom: Copy> Copy for ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>

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

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(
    &self,
    other: &ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom>
) -> bool

This method tests for !=.

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

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

Formats the value using the given formatter.