Struct libp2p::swarm::protocols_handler::MapOutEvent
source · [−]pub struct MapOutEvent<TProtoHandler, TMap> { /* private fields */ }
Expand description
Wrapper around a protocol handler that turns the output event into something else.
Trait Implementations
sourceimpl<TProtoHandler, TMap, TNewOut> ProtocolsHandler for MapOutEvent<TProtoHandler, TMap> where
TProtoHandler: ProtocolsHandler,
TMap: FnMut(<TProtoHandler as ProtocolsHandler>::OutEvent) -> TNewOut + 'static + Send,
TNewOut: 'static + Send,
impl<TProtoHandler, TMap, TNewOut> ProtocolsHandler for MapOutEvent<TProtoHandler, TMap> where
TProtoHandler: ProtocolsHandler,
TMap: FnMut(<TProtoHandler as ProtocolsHandler>::OutEvent) -> TNewOut + 'static + Send,
TNewOut: 'static + Send,
type InEvent = <TProtoHandler as ProtocolsHandler>::InEvent
type InEvent = <TProtoHandler as ProtocolsHandler>::InEvent
Custom event that can be received from the outside.
type OutEvent = TNewOut
type OutEvent = TNewOut
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = <TProtoHandler as ProtocolsHandler>::Error
type Error = <TProtoHandler as ProtocolsHandler>::Error
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = <TProtoHandler as ProtocolsHandler>::InboundProtocol
type InboundProtocol = <TProtoHandler as ProtocolsHandler>::InboundProtocol
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = <TProtoHandler as ProtocolsHandler>::OutboundProtocol
type OutboundProtocol = <TProtoHandler as ProtocolsHandler>::OutboundProtocol
The outbound upgrade for the protocol(s) used by the handler.
type InboundOpenInfo = <TProtoHandler as ProtocolsHandler>::InboundOpenInfo
type InboundOpenInfo = <TProtoHandler as ProtocolsHandler>::InboundOpenInfo
The type of additional information returned from listen_protocol
.
type OutboundOpenInfo = <TProtoHandler as ProtocolsHandler>::OutboundOpenInfo
type OutboundOpenInfo = <TProtoHandler as ProtocolsHandler>::OutboundOpenInfo
The type of additional information passed to an OutboundSubstreamRequest
.
sourcepub fn listen_protocol(
&self
) -> SubstreamProtocol<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo>
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo>
The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
sourcepub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo
)
pub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo
)
Injects the output of a successful upgrade on a new inbound substream.
sourcepub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo
)
pub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo
)
Injects the output of a successful upgrade on a new outbound substream. Read more
sourcepub fn inject_event(
&mut self,
event: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InEvent
)
pub fn inject_event(
&mut self,
event: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InEvent
)
Injects an event coming from the outside in the handler.
sourcepub fn inject_address_change(&mut self, addr: &Multiaddr)
pub fn inject_address_change(&mut self, addr: &Multiaddr)
Notifies the handler of a change in the address of the remote.
sourcepub fn inject_dial_upgrade_error(
&mut self,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
pub fn inject_dial_upgrade_error(
&mut self,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
sourcepub fn inject_listen_upgrade_error(
&mut self,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
pub fn inject_listen_upgrade_error(
&mut self,
info: <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
sourcepub fn connection_keep_alive(&self) -> KeepAlive
pub fn connection_keep_alive(&self) -> KeepAlive
Returns until when the connection should be kept alive. Read more
sourcepub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutEvent, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::Error>>
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundProtocol, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutboundOpenInfo, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::OutEvent, <MapOutEvent<TProtoHandler, TMap> as ProtocolsHandler>::Error>>
Should behave like Stream::poll()
.
sourcefn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
Adds a closure that turns the input event into something else.
sourcefn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
Adds a closure that turns the output event into something else.
sourcefn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
fn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
Creates a new ProtocolsHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read more
sourcefn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
Creates a builder that allows creating a NodeHandler
that handles this protocol
exclusively. Read more
Auto Trait Implementations
impl<TProtoHandler, TMap> RefUnwindSafe for MapOutEvent<TProtoHandler, TMap> where
TMap: RefUnwindSafe,
TProtoHandler: RefUnwindSafe,
impl<TProtoHandler, TMap> Send for MapOutEvent<TProtoHandler, TMap> where
TMap: Send,
TProtoHandler: Send,
impl<TProtoHandler, TMap> Sync for MapOutEvent<TProtoHandler, TMap> where
TMap: Sync,
TProtoHandler: Sync,
impl<TProtoHandler, TMap> Unpin for MapOutEvent<TProtoHandler, TMap> where
TMap: Unpin,
TProtoHandler: Unpin,
impl<TProtoHandler, TMap> UnwindSafe for MapOutEvent<TProtoHandler, TMap> where
TMap: UnwindSafe,
TProtoHandler: UnwindSafe,
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,
impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,
type Handler = T
type Handler = T
The protocols handler.
sourcepub fn into_handler(self, &PeerId, &ConnectedPoint) -> T
pub fn into_handler(self, &PeerId, &ConnectedPoint) -> T
Builds the protocols handler. Read more
sourcepub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
Return the handler’s inbound protocol.
sourcefn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the
other one together. Read more
sourcefn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
Creates a builder that will allow creating a NodeHandler
that handles this protocol
exclusively. Read more