Struct libp2p_core::protocols_handler::Fuse

pub struct Fuse<TProtoHandler> { /* fields omitted */ }

Wrapper around a protocol handler and ignores all further method calls once it has shut down.

Methods

impl<TProtoHandler> Fuse<TProtoHandler>

pub fn is_shutdown(&self) -> bool

Returns true if polling has returned Shutdown in the past.

Trait Implementations

impl<TProtoHandler> ProtocolsHandler for Fuse<TProtoHandler> where
    TProtoHandler: ProtocolsHandler, 

type InEvent = TProtoHandler::InEvent

Custom event that can be received from the outside.

type OutEvent = TProtoHandler::OutEvent

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

type Error = TProtoHandler::Error

Error that can happen when polling.

type Substream = TProtoHandler::Substream

The type of the substream that contains the raw data.

type InboundProtocol = EitherUpgrade<TProtoHandler::InboundProtocol, DeniedUpgrade>

The upgrade for the protocol or protocols handled by this handler.

type OutboundProtocol = TProtoHandler::OutboundProtocol

The upgrade for the protocol or protocols handled by this handler.

type OutboundOpenInfo = TProtoHandler::OutboundOpenInfo

Information about a substream. Can be sent to the handler through a NodeHandlerEndpoint, and will be passed back in inject_substream or inject_outbound_closed.

fn listen_protocol(&self) -> Self::InboundProtocol

Produces a ConnectionUpgrade for the protocol or protocols to accept when listening.

fn inject_fully_negotiated_inbound(
    &mut self,
    protocol: <Self::InboundProtocol as InboundUpgrade<Self::Substream>>::Output
)

Injects a fully-negotiated substream in the handler.

fn inject_fully_negotiated_outbound(
    &mut self,
    protocol: <Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Output,
    info: Self::OutboundOpenInfo
)

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

Injects an event coming from the outside in the handler.

fn inject_dial_upgrade_error(
    &mut self,
    info: Self::OutboundOpenInfo,
    error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgrade<Self::Substream>>::Error>
)

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

fn inject_inbound_closed(&mut self)

Indicates to the handler that the inbound part of the muxer has been closed, and that therefore no more inbound substreams will be produced.

fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive.

fn shutdown(&mut self)

Indicates to the node that it should shut down. After that, it is expected that poll() returns Ready(ProtocolsHandlerEvent::Shutdown) as soon as possible.

fn poll(
    &mut self
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent>, Self::Error>

Should behave like Stream::poll(). Should close if no more event can be produced and the node should be closed.

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 fuse(self) -> Fuse<Self> where
    Self: Sized, 

Wraps around self. When poll() returns Shutdown, any further call to any method will be ignored.

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

Builds an implementation of ProtocolsHandler that handles both this protocol and the other one together.

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

Creates a builder that will allow creating a NodeHandler that handles this protocol exclusively.

fn into_node_handler(self) -> NodeHandlerWrapper<Self> where
    Self: Sized, 

Deprecated:

Use into_node_handler_builder instead

Builds an implementation of NodeHandler that handles this protocol exclusively.

impl<TProtoHandler: Clone> Clone for Fuse<TProtoHandler>

fn clone(&self) -> Fuse<TProtoHandler>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<TProtoHandler: Copy> Copy for Fuse<TProtoHandler>

impl<TProtoHandler: Debug> Debug for Fuse<TProtoHandler>

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

Formats the value using the given formatter.