Struct libp2p_swarm::protocols_handler::ProtocolsHandlerSelect

[+] Show declaration

pub struct ProtocolsHandlerSelect<TProto1, TProto2> { /* fields omitted */ }

[−] Expand description

Implementation of ProtocolsHandler that combines two protocols into one.

Trait Implementations

impl<TProto1: Clone, TProto2: Clone> Clone for ProtocolsHandlerSelect<TProto1, TProto2>[+]

[+] Show hidden undocumented items

fn clone(&self) -> ProtocolsHandlerSelect<TProto1, TProto2>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TProto1: Debug, TProto2: Debug> Debug for ProtocolsHandlerSelect<TProto1, TProto2>[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
    TProto1: ProtocolsHandler,
    TProto2: ProtocolsHandler, [+]

[+] Show hidden undocumented items

type InEvent = EitherOutput<TProto1::InEvent, TProto2::InEvent>

Custom event that can be received from the outside.

type OutEvent = EitherOutput<TProto1::OutEvent, TProto2::OutEvent>

Custom event that can be produced by the handler and that will be returned to the outside.

type Error = EitherError<TProto1::Error, TProto2::Error>

The type of errors returned by ProtocolsHandler::poll.

type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::InboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::InboundProtocol>>

The inbound upgrade for the protocol(s) used by the handler.

type OutboundProtocol = EitherUpgrade<SendWrapper<TProto1::OutboundProtocol>, SendWrapper<TProto2::OutboundProtocol>>

The outbound upgrade for the protocol(s) used by the handler.

type OutboundOpenInfo = EitherOutput<TProto1::OutboundOpenInfo, TProto2::OutboundOpenInfo>

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = (TProto1::InboundOpenInfo, TProto2::InboundOpenInfo)

The type of additional information returned from listen_protocol.

fn listen_protocol(
    &self
) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>[−]

The InboundUpgrade to apply on inbound substreams to negotiate the desired protocols.

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
    endpoint: Self::OutboundOpenInfo
)[−]

Injects the output of a successful upgrade on a new outbound substream.

fn inject_fully_negotiated_inbound(
    &mut self,
    protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output,
    (i1, i2): Self::InboundOpenInfo
)[−]

Injects the output of a successful upgrade on a new inbound substream.

fn inject_event(&mut self, event: Self::InEvent)[−]

Injects an event coming from the outside in the handler.

fn inject_address_change(&mut self, new_address: &Multiaddr)[−]

Notifies the handler of a change in the address of the remote.

fn inject_dial_upgrade_error(
    &mut self,
    info: Self::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>
)[−]

Indicates to the handler that upgrading an outbound substream to the given protocol has failed.

fn inject_listen_upgrade_error(
    &mut self,
    (i1, i2): Self::InboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>
)[−]

Indicates to the handler that upgrading an inbound substream to the given protocol has failed.

fn connection_keep_alive(&self) -> KeepAlive[−]

Returns until when the connection should be kept alive.

fn poll(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>[−]

Should behave like Stream::poll().

fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
    Self: Sized,
    TMap: Fn(&TNewIn) -> Option<&Self::InEvent>, [−]

Adds a closure that turns the input event into something else.

fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
    Self: Sized,
    TMap: FnMut(Self::OutEvent) -> TNewOut, [−]

Adds a closure that turns the output event into something else.

fn select<TProto2>(
    self,
    other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2> where
    Self: Sized, [−]

Creates a new ProtocolsHandler that selects either this handler or other by delegating methods calls appropriately.

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self> where
    Self: Sized, [−]

Creates a builder that allows creating a NodeHandler that handles this protocol exclusively.