Struct libp2p::swarm::ProtocolsHandlerSelect [−][src]
pub struct ProtocolsHandlerSelect<TProto1, TProto2> { /* fields omitted */ }
Expand description
Implementation of ProtocolsHandler
that combines two protocols into one.
Trait Implementations
impl<TProto1, TProto2> Clone for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Clone,
TProto2: Clone,
[src]
impl<TProto1, TProto2> Clone for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Clone,
TProto2: Clone,
[src]pub fn clone(&self) -> ProtocolsHandlerSelect<TProto1, TProto2>
[src]
pub fn clone(&self) -> ProtocolsHandlerSelect<TProto1, TProto2>
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl<TProto1, TProto2> Debug for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Debug,
TProto2: Debug,
[src]
impl<TProto1, TProto2> Debug for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Debug,
TProto2: Debug,
[src]impl<TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: ProtocolsHandler,
TProto2: ProtocolsHandler,
[src]
impl<TProto1, TProto2> ProtocolsHandler for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: ProtocolsHandler,
TProto2: ProtocolsHandler,
[src]type InEvent = EitherOutput<<TProto1 as ProtocolsHandler>::InEvent, <TProto2 as ProtocolsHandler>::InEvent>
type InEvent = EitherOutput<<TProto1 as ProtocolsHandler>::InEvent, <TProto2 as ProtocolsHandler>::InEvent>
Custom event that can be received from the outside.
type OutEvent = EitherOutput<<TProto1 as ProtocolsHandler>::OutEvent, <TProto2 as ProtocolsHandler>::OutEvent>
type OutEvent = EitherOutput<<TProto1 as ProtocolsHandler>::OutEvent, <TProto2 as ProtocolsHandler>::OutEvent>
Custom event that can be produced by the handler and that will be returned to the outside.
type Error = EitherError<<TProto1 as ProtocolsHandler>::Error, <TProto2 as ProtocolsHandler>::Error>
type Error = EitherError<<TProto1 as ProtocolsHandler>::Error, <TProto2 as ProtocolsHandler>::Error>
The type of errors returned by ProtocolsHandler::poll
.
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::InboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::InboundProtocol>>
type InboundProtocol = SelectUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::InboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::InboundProtocol>>
The inbound upgrade for the protocol(s) used by the handler.
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::OutboundProtocol>>
type OutboundProtocol = EitherUpgrade<SendWrapper<<TProto1 as ProtocolsHandler>::OutboundProtocol>, SendWrapper<<TProto2 as ProtocolsHandler>::OutboundProtocol>>
The outbound upgrade for the protocol(s) used by the handler.
type OutboundOpenInfo = EitherOutput<<TProto1 as ProtocolsHandler>::OutboundOpenInfo, <TProto2 as ProtocolsHandler>::OutboundOpenInfo>
type OutboundOpenInfo = EitherOutput<<TProto1 as ProtocolsHandler>::OutboundOpenInfo, <TProto2 as ProtocolsHandler>::OutboundOpenInfo>
The type of additional information passed to an OutboundSubstreamRequest
.
type InboundOpenInfo = (<TProto1 as ProtocolsHandler>::InboundOpenInfo, <TProto2 as ProtocolsHandler>::InboundOpenInfo)
type InboundOpenInfo = (<TProto1 as ProtocolsHandler>::InboundOpenInfo, <TProto2 as ProtocolsHandler>::InboundOpenInfo)
The type of additional information returned from listen_protocol
.
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo>
[src]
pub fn listen_protocol(
&self
) -> SubstreamProtocol<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo>
[src]The InboundUpgrade
to apply on inbound
substreams to negotiate the desired protocols. Read more
pub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
endpoint: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo
)
[src]
pub fn inject_fully_negotiated_outbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Output,
endpoint: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo
)
[src]Injects the output of a successful upgrade on a new outbound substream. Read more
pub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo
)
[src]
pub fn inject_fully_negotiated_inbound(
&mut self,
protocol: <<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Output,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo
)
[src]Injects the output of a successful upgrade on a new inbound substream.
pub fn inject_event(
&mut self,
event: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InEvent
)
[src]
pub fn inject_event(
&mut self,
event: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InEvent
)
[src]Injects an event coming from the outside in the handler.
pub fn inject_address_change(&mut self, new_address: &Multiaddr)
[src]
pub fn inject_address_change(&mut self, new_address: &Multiaddr)
[src]Notifies the handler of a change in the address of the remote.
pub fn inject_dial_upgrade_error(
&mut self,
info: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
[src]
pub fn inject_dial_upgrade_error(
&mut self,
info: <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol as OutboundUpgradeSend>::Error>
)
[src]Indicates to the handler that upgrading an outbound substream to the given protocol has failed.
pub fn inject_listen_upgrade_error(
&mut self,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
[src]
pub fn inject_listen_upgrade_error(
&mut self,
<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundOpenInfo,
error: ProtocolsHandlerUpgrErr<<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::InboundProtocol as InboundUpgradeSend>::Error>
)
[src]Indicates to the handler that upgrading an inbound substream to the given protocol has failed.
pub fn connection_keep_alive(&self) -> KeepAlive
[src]
pub fn connection_keep_alive(&self) -> KeepAlive
[src]Returns until when the connection should be kept alive. Read more
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutEvent, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::Error>>
[src]
pub fn poll(
&mut self,
cx: &mut Context<'_>
) -> Poll<ProtocolsHandlerEvent<<ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundProtocol, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutboundOpenInfo, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::OutEvent, <ProtocolsHandlerSelect<TProto1, TProto2> as ProtocolsHandler>::Error>>
[src]Should behave like Stream::poll()
.
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
[src]
fn map_in_event<TNewIn, TMap>(self, map: TMap) -> MapInEvent<Self, TNewIn, TMap> where
TMap: Fn(&TNewIn) -> Option<&Self::InEvent>,
[src]Adds a closure that turns the input event into something else.
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
[src]
fn map_out_event<TMap, TNewOut>(self, map: TMap) -> MapOutEvent<Self, TMap> where
TMap: FnMut(Self::OutEvent) -> TNewOut,
[src]Adds a closure that turns the output event into something else.
fn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
[src]
fn select<TProto2>(
self,
other: TProto2
) -> ProtocolsHandlerSelect<Self, TProto2>
[src]Creates a new ProtocolsHandler
that selects either this handler or
other
by delegating methods calls appropriately. Read more
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]Creates a builder that allows creating a NodeHandler
that handles this protocol
exclusively. Read more
Auto Trait Implementations
impl<TProto1, TProto2> RefUnwindSafe for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: RefUnwindSafe,
TProto2: RefUnwindSafe,
TProto1: RefUnwindSafe,
TProto2: RefUnwindSafe,
impl<TProto1, TProto2> Send for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Send,
TProto2: Send,
TProto1: Send,
TProto2: Send,
impl<TProto1, TProto2> Sync for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Sync,
TProto2: Sync,
TProto1: Sync,
TProto2: Sync,
impl<TProto1, TProto2> Unpin for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: Unpin,
TProto2: Unpin,
TProto1: Unpin,
TProto2: Unpin,
impl<TProto1, TProto2> UnwindSafe for ProtocolsHandlerSelect<TProto1, TProto2> where
TProto1: UnwindSafe,
TProto2: UnwindSafe,
TProto1: UnwindSafe,
TProto2: UnwindSafe,
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,
[src]
impl<T> IntoProtocolsHandler for T where
T: ProtocolsHandler,
[src]type Handler = T
type Handler = T
The protocols handler.
pub fn into_handler(self, &PeerId, &ConnectedPoint) -> T
[src]
pub fn into_handler(self, &PeerId, &ConnectedPoint) -> T
[src]Builds the protocols handler. Read more
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
[src]
pub fn inbound_protocol(
&self
) -> <<T as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InboundProtocol
[src]Return the handler’s inbound protocol.
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
[src]
fn select<TProto2>(
self,
other: TProto2
) -> IntoProtocolsHandlerSelect<Self, TProto2>
[src]Builds an implementation of IntoProtocolsHandler
that handles both this protocol and the
other one together. Read more
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]
fn into_node_handler_builder(self) -> NodeHandlerWrapperBuilder<Self>
[src]Creates a builder that will allow creating a NodeHandler
that handles this protocol
exclusively. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,