Struct libp2p_swarm::behaviour::toggle::ToggleConnectionHandler
source · pub struct ToggleConnectionHandler<TInner> { /* private fields */ }
Expand description
Implementation of ConnectionHandler
that can be in the disabled state.
Trait Implementations§
source§impl<TInner> ConnectionHandler for ToggleConnectionHandler<TInner>where
TInner: ConnectionHandler,
impl<TInner> ConnectionHandler for ToggleConnectionHandler<TInner>where
TInner: ConnectionHandler,
§type FromBehaviour = <TInner as ConnectionHandler>::FromBehaviour
type FromBehaviour = <TInner as ConnectionHandler>::FromBehaviour
A type representing the message(s) a
NetworkBehaviour
can send to a ConnectionHandler
via ToSwarm::NotifyHandler
§type ToBehaviour = <TInner as ConnectionHandler>::ToBehaviour
type ToBehaviour = <TInner as ConnectionHandler>::ToBehaviour
A type representing message(s) a
ConnectionHandler
can send to a NetworkBehaviour
via ConnectionHandlerEvent::NotifyBehaviour
.§type Error = <TInner as ConnectionHandler>::Error
type Error = <TInner as ConnectionHandler>::Error
👎Deprecated: Will be removed together with
ConnectionHandlerEvent::Close
. See https://github.com/libp2p/rust-libp2p/issues/3591 for details.The type of errors returned by
ConnectionHandler::poll
.§type InboundProtocol = Either<SendWrapper<<TInner as ConnectionHandler>::InboundProtocol>, SendWrapper<DeniedUpgrade>>
type InboundProtocol = Either<SendWrapper<<TInner as ConnectionHandler>::InboundProtocol>, SendWrapper<DeniedUpgrade>>
The inbound upgrade for the protocol(s) used by the handler.
§type OutboundProtocol = <TInner as ConnectionHandler>::OutboundProtocol
type OutboundProtocol = <TInner as ConnectionHandler>::OutboundProtocol
The outbound upgrade for the protocol(s) used by the handler.
§type OutboundOpenInfo = <TInner as ConnectionHandler>::OutboundOpenInfo
type OutboundOpenInfo = <TInner as ConnectionHandler>::OutboundOpenInfo
The type of additional information passed to an
OutboundSubstreamRequest
.§type InboundOpenInfo = Either<<TInner as ConnectionHandler>::InboundOpenInfo, ()>
type InboundOpenInfo = Either<<TInner as ConnectionHandler>::InboundOpenInfo, ()>
The type of additional information returned from
listen_protocol
.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 on_behaviour_event(&mut self, event: Self::FromBehaviour)
fn on_behaviour_event(&mut self, event: Self::FromBehaviour)
Informs the handler about an event from the
NetworkBehaviour
.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<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::ToBehaviour, Self::Error>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ConnectionHandlerEvent<Self::OutboundProtocol, Self::OutboundOpenInfo, Self::ToBehaviour, Self::Error>>
Should behave like
Stream::poll()
.fn on_connection_event( &mut self, event: ConnectionEvent<'_, Self::InboundProtocol, Self::OutboundProtocol, Self::InboundOpenInfo, Self::OutboundOpenInfo>, )
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,
) -> ConnectionHandlerSelect<Self, TProto2>where
Self: Sized,
fn select<TProto2>(
self,
other: TProto2,
) -> ConnectionHandlerSelect<Self, TProto2>where
Self: Sized,
Creates a new
ConnectionHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read moreAuto Trait Implementations§
impl<TInner> Freeze for ToggleConnectionHandler<TInner>where
TInner: Freeze,
impl<TInner> RefUnwindSafe for ToggleConnectionHandler<TInner>where
TInner: RefUnwindSafe,
impl<TInner> Send for ToggleConnectionHandler<TInner>where
TInner: Send,
impl<TInner> Sync for ToggleConnectionHandler<TInner>where
TInner: Sync,
impl<TInner> Unpin for ToggleConnectionHandler<TInner>where
TInner: Unpin,
impl<TInner> UnwindSafe for ToggleConnectionHandler<TInner>where
TInner: UnwindSafe,
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> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
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 more