pub struct MapInEvent<TProtoHandler, TNewIn, TMap> { /* private fields */ }
Expand description
Wrapper around a protocol handler that turns the input event into something else.
Trait Implementations§
Source§impl<TProtoHandler, TMap, TNewIn> ProtocolsHandler for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TMap, TNewIn> ProtocolsHandler for MapInEvent<TProtoHandler, TNewIn, TMap>
Source§type OutEvent = <TProtoHandler as ProtocolsHandler>::OutEvent
type OutEvent = <TProtoHandler as ProtocolsHandler>::OutEvent
Custom event that can be produced by the handler and that will be returned to the outside.
Source§type Error = <TProtoHandler as ProtocolsHandler>::Error
type Error = <TProtoHandler as ProtocolsHandler>::Error
The type of errors returned by
ProtocolsHandler::poll
.Source§type InboundProtocol = <TProtoHandler as ProtocolsHandler>::InboundProtocol
type InboundProtocol = <TProtoHandler as ProtocolsHandler>::InboundProtocol
The inbound upgrade for the protocol(s) used by the handler.
Source§type OutboundProtocol = <TProtoHandler as ProtocolsHandler>::OutboundProtocol
type OutboundProtocol = <TProtoHandler as ProtocolsHandler>::OutboundProtocol
The outbound upgrade for the protocol(s) used by the handler.
Source§type InboundOpenInfo = <TProtoHandler as ProtocolsHandler>::InboundOpenInfo
type InboundOpenInfo = <TProtoHandler as ProtocolsHandler>::InboundOpenInfo
The type of additional information returned from
listen_protocol
.Source§type OutboundOpenInfo = <TProtoHandler as ProtocolsHandler>::OutboundOpenInfo
type OutboundOpenInfo = <TProtoHandler as ProtocolsHandler>::OutboundOpenInfo
The type of additional information passed to an
OutboundSubstreamRequest
.Source§fn listen_protocol(
&self,
) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>
fn listen_protocol( &self, ) -> SubstreamProtocol<Self::InboundProtocol, Self::InboundOpenInfo>
The
InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read moreSource§fn inject_fully_negotiated_inbound(
&mut self,
protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output,
info: Self::InboundOpenInfo,
)
fn inject_fully_negotiated_inbound( &mut self, protocol: <Self::InboundProtocol as InboundUpgradeSend>::Output, info: Self::InboundOpenInfo, )
Injects the output of a successful upgrade on a new inbound substream.
Source§fn inject_fully_negotiated_outbound(
&mut self,
protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output,
info: Self::OutboundOpenInfo,
)
fn inject_fully_negotiated_outbound( &mut self, protocol: <Self::OutboundProtocol as OutboundUpgradeSend>::Output, info: Self::OutboundOpenInfo, )
Injects the output of a successful upgrade on a new outbound substream. Read more
Source§fn inject_event(&mut self, event: TNewIn)
fn inject_event(&mut self, event: TNewIn)
Injects an event coming from the outside in the handler.
Source§fn inject_address_change(&mut self, addr: &Multiaddr)
fn inject_address_change(&mut self, addr: &Multiaddr)
Notifies the handler of a change in the address of the remote.
Source§fn inject_dial_upgrade_error(
&mut self,
info: Self::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::OutboundProtocol as OutboundUpgradeSend>::Error>,
)
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.
Source§fn inject_listen_upgrade_error(
&mut self,
info: Self::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>,
)
fn inject_listen_upgrade_error( &mut self, info: Self::InboundOpenInfo, error: ProtocolsHandlerUpgrErr<<Self::InboundProtocol as InboundUpgradeSend>::Error>, )
Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
Source§fn connection_keep_alive(&self) -> KeepAlive
fn connection_keep_alive(&self) -> KeepAlive
Returns until when the connection should be kept alive. Read more
Source§fn poll(
&mut self,
cx: &mut Context<'_>,
) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ProtocolsHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::OutEvent, Self::Error>>
Should behave like
Stream::poll()
.Source§fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap>
Adds a closure that turns the input event into something else.
Source§fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap>
Adds a closure that turns the output event into something else.
Source§fn select<TProto2>(
self,
other: TProto2,
) -> ProtocolsHandlerSelect<Self, TProto2>where
Self: Sized,
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. Read moreSource§fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>where
Self: Sized,
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>where
Self: Sized,
Creates a builder that allows creating a
NodeHandler
that handles this protocol
exclusively. Read moreAuto Trait Implementations§
impl<TProtoHandler, TNewIn, TMap> Freeze for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TNewIn, TMap> RefUnwindSafe for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TNewIn, TMap> Send for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TNewIn, TMap> Sync for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TNewIn, TMap> Unpin for MapInEvent<TProtoHandler, TNewIn, TMap>
impl<TProtoHandler, TNewIn, TMap> UnwindSafe for MapInEvent<TProtoHandler, TNewIn, TMap>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoProtocolsHandler for Twhere
T: ProtocolsHandler,
impl<T> IntoProtocolsHandler for Twhere
T: ProtocolsHandler,
Source§fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
fn into_handler(self, _: &PeerId, _: &ConnectedPoint) -> T
Builds the protocols handler. Read more
Source§fn inbound_protocol(
&self,
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
fn inbound_protocol( &self, ) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
Return the handler’s inbound protocol.
Source§fn select<TProto2>(
self,
other: TProto2,
) -> IntoProtocolsHandlerSelect<Self, TProto2>where
Self: Sized,
fn select<TProto2>(
self,
other: TProto2,
) -> IntoProtocolsHandlerSelect<Self, TProto2>where
Self: Sized,
Builds an implementation of
IntoProtocolsHandler
that handles both this protocol and the
other one together.Source§fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>where
Self: Sized,
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.