Struct libp2p::swarm::toggle::ToggleProtoHandler

source · [−]

pub struct ToggleProtoHandler<TInner> { /* private fields */ }

Expand description

Implementation of ProtocolsHandler that can be in the disabled state.

Trait Implementations

source

impl<TInner> ProtocolsHandler for ToggleProtoHandler<TInner> where
TInner: ProtocolsHandler,

type InEvent = <TInner as ProtocolsHandler>::InEvent

Custom event that can be received from the outside.

type OutEvent = <TInner as ProtocolsHandler>::OutEvent

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

type Error = <TInner as ProtocolsHandler>::Error

The type of errors returned by ProtocolsHandler::poll.

type InboundProtocol = EitherUpgrade<SendWrapper<<TInner as ProtocolsHandler>::InboundProtocol>, SendWrapper<DeniedUpgrade>>

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

type OutboundProtocol = <TInner as ProtocolsHandler>::OutboundProtocol

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

type OutboundOpenInfo = <TInner as ProtocolsHandler>::OutboundOpenInfo

The type of additional information passed to an OutboundSubstreamRequest.

type InboundOpenInfo = Either<<TInner as ProtocolsHandler>::InboundOpenInfo, ()>

The type of additional information returned from listen_protocol.

source

pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol, <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo>

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

source

pub fn inject_fully_negotiated_inbound(
 &mut self,
 out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
 info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo
)

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

source

pub fn inject_fully_negotiated_outbound(
 &mut self,
 out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
 info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo
)

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

source

pub fn inject_event(
&mut self,
event: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InEvent
)

Injects an event coming from the outside in the handler.

source

pub fn inject_address_change(&mut self, addr: &Multiaddr)

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

source

pub fn inject_dial_upgrade_error(
 &mut self,
 info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo,
 err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)

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

source

pub fn inject_listen_upgrade_error(
 &mut self,
 info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo,
 err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)

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

source

pub fn connection_keep_alive(&self) -> KeepAlive

Returns until when the connection should be kept alive. Read more

source

pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol, <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo, <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutEvent, <ToggleProtoHandler<TInner> as ProtocolsHandler>::Error>>

Should behave like Stream::poll().

source

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.

source

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.

source

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

source

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<TInner> RefUnwindSafe for ToggleProtoHandler<TInner> where
TInner: RefUnwindSafe,

impl<TInner> Send for ToggleProtoHandler<TInner> where
TInner: Send,

impl<TInner> Sync for ToggleProtoHandler<TInner> where
TInner: Sync,

impl<TInner> Unpin for ToggleProtoHandler<TInner> where
TInner: Unpin,

impl<TInner> UnwindSafe for ToggleProtoHandler<TInner> where
TInner: UnwindSafe,

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,

type Handler = T

The protocols handler.

source

pub fn into_handler(self, &PeerId, &ConnectedPoint) -> T

Builds the protocols handler. Read more

source

pub 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>

Builds an implementation of IntoProtocolsHandler that handles both this protocol and the other one together. Read more

source

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

source

Struct libp2p::swarm::toggle::ToggleProtoHandler

Trait Implementations

impl<TInner> ProtocolsHandler for ToggleProtoHandler<TInner> where TInner: ProtocolsHandler,

type InEvent = <TInner as ProtocolsHandler>::InEvent

type OutEvent = <TInner as ProtocolsHandler>::OutEvent

type Error = <TInner as ProtocolsHandler>::Error

type InboundProtocol = EitherUpgrade<SendWrapper<<TInner as ProtocolsHandler>::InboundProtocol>, SendWrapper<DeniedUpgrade>>

type OutboundProtocol = <TInner as ProtocolsHandler>::OutboundProtocol

type OutboundOpenInfo = <TInner as ProtocolsHandler>::OutboundOpenInfo

type InboundOpenInfo = Either<<TInner as ProtocolsHandler>::InboundOpenInfo, ()>

pub fn listen_protocol( &self) -> SubstreamProtocol<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol, <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo>

pub fn inject_fully_negotiated_inbound( &mut self, out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output, info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo)

pub fn inject_fully_negotiated_outbound( &mut self, out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output, info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo)

pub fn inject_event( &mut self, event: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InEvent)

pub fn inject_address_change(&mut self, addr: &Multiaddr)

pub fn inject_dial_upgrade_error( &mut self, info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo, err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>)

pub fn inject_listen_upgrade_error( &mut self, info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo, err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>)

pub fn connection_keep_alive(&self) -> KeepAlive

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

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

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

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

Auto Trait Implementations

impl<TInner> RefUnwindSafe for ToggleProtoHandler<TInner> where TInner: RefUnwindSafe,

impl<TInner> Send for ToggleProtoHandler<TInner> where TInner: Send,

impl<TInner> Sync for ToggleProtoHandler<TInner> where TInner: Sync,

impl<TInner> Unpin for ToggleProtoHandler<TInner> where TInner: Unpin,

impl<TInner> UnwindSafe for ToggleProtoHandler<TInner> where TInner: UnwindSafe,

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> IntoProtocolsHandler for T where T: ProtocolsHandler,

type Handler = T

pub fn into_handler(self, &PeerId, &ConnectedPoint) -> T

pub fn inbound_protocol( &self) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol

fn select<TProto2>( self, other: TProto2) -> IntoProtocolsHandlerSelect<Self, TProto2>

fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<TInner> ProtocolsHandler for ToggleProtoHandler<TInner> where
TInner: ProtocolsHandler,

pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol, <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo>

pub fn inject_fully_negotiated_inbound(
&mut self,
out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo
)

pub fn inject_fully_negotiated_outbound(
&mut self,
out: <<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo
)

pub fn inject_event(
&mut self,
event: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InEvent
)

pub fn inject_dial_upgrade_error(
&mut self,
info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundOpenInfo,
err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)

pub fn inject_listen_upgrade_error(
&mut self,
info: <ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundOpenInfo,
err: ProtocolsHandlerUpgrErr<<<ToggleProtoHandler<TInner> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)

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

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

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

impl<TInner> RefUnwindSafe for ToggleProtoHandler<TInner> where
TInner: RefUnwindSafe,

impl<TInner> Send for ToggleProtoHandler<TInner> where
TInner: Send,

impl<TInner> Sync for ToggleProtoHandler<TInner> where
TInner: Sync,

impl<TInner> Unpin for ToggleProtoHandler<TInner> where
TInner: Unpin,

impl<TInner> UnwindSafe for ToggleProtoHandler<TInner> where
TInner: UnwindSafe,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,

pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol

fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,