Enum libp2p_swarm::protocols_handler::ProtocolsHandlerEvent

pub enum ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom, TErr> {
    OutboundSubstreamRequest {
        protocol: SubstreamProtocol<TConnectionUpgrade, TOutboundOpenInfo>,
    },
    Close(TErr),
    Custom(TCustom),
}

Event produced by a handler.

Variants

OutboundSubstreamRequest

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

Fields of OutboundSubstreamRequest

protocol: SubstreamProtocol<TConnectionUpgrade, TOutboundOpenInfo>

The protocol(s) to apply on the substream.

Close(TErr)

Close the connection for the given reason.

Custom(TCustom)

Other event.

Implementations

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

Event produced by a handler.

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

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

pub fn map_close<F, I>(
    self,
    map: F
) -> ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom, I> where
    F: FnOnce(TErr) -> I, 

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

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

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

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

This method tests for !=.

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

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

impl<TConnectionUpgrade, TOutboundOpenInfo, TCustom, TErr> StructuralEq for ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom, TErr>

impl<TConnectionUpgrade, TOutboundOpenInfo, TCustom, TErr> StructuralPartialEq for ProtocolsHandlerEvent<TConnectionUpgrade, TOutboundOpenInfo, TCustom, TErr>