Struct Toggle
pub struct Toggle<TBehaviour> { /* private fields */ }
Expand description
Implementation of NetworkBehaviour
that can be either in the disabled or enabled state.
The state can only be chosen at initialization.
Implementations§
§impl<TBehaviour> Toggle<TBehaviour>
impl<TBehaviour> Toggle<TBehaviour>
pub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Returns true
if Toggle
is enabled and false
if it’s disabled.
pub fn as_ref(&self) -> Option<&TBehaviour>
pub fn as_ref(&self) -> Option<&TBehaviour>
Returns a reference to the inner NetworkBehaviour
.
pub fn as_mut(&mut self) -> Option<&mut TBehaviour>
pub fn as_mut(&mut self) -> Option<&mut TBehaviour>
Returns a mutable reference to the inner NetworkBehaviour
.
Trait Implementations§
§impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>where
TBehaviour: NetworkBehaviour,
impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>where
TBehaviour: NetworkBehaviour,
§type ConnectionHandler = ToggleConnectionHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>
type ConnectionHandler = ToggleConnectionHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>
Handler for all the protocols the network behaviour supports.
§type ToSwarm = <TBehaviour as NetworkBehaviour>::ToSwarm
type ToSwarm = <TBehaviour as NetworkBehaviour>::ToSwarm
Event generated by the
NetworkBehaviour
and that the swarm will report back.§fn handle_pending_inbound_connection(
&mut self,
connection_id: ConnectionId,
local_addr: &Multiaddr,
remote_addr: &Multiaddr,
) -> Result<(), ConnectionDenied>
fn handle_pending_inbound_connection( &mut self, connection_id: ConnectionId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<(), ConnectionDenied>
Callback that is invoked for every new inbound connection. Read more
§fn handle_established_inbound_connection(
&mut self,
connection_id: ConnectionId,
peer: PeerId,
local_addr: &Multiaddr,
remote_addr: &Multiaddr,
) -> Result<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
Callback that is invoked for every established inbound connection. Read more
§fn handle_pending_outbound_connection(
&mut self,
connection_id: ConnectionId,
maybe_peer: Option<PeerId>,
addresses: &[Multiaddr],
effective_role: Endpoint,
) -> Result<Vec<Multiaddr>, ConnectionDenied>
fn handle_pending_outbound_connection( &mut self, connection_id: ConnectionId, maybe_peer: Option<PeerId>, addresses: &[Multiaddr], effective_role: Endpoint, ) -> Result<Vec<Multiaddr>, ConnectionDenied>
Callback that is invoked for every outbound connection attempt. Read more
§fn handle_established_outbound_connection(
&mut self,
connection_id: ConnectionId,
peer: PeerId,
addr: &Multiaddr,
role_override: Endpoint,
port_use: PortUse,
) -> Result<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, port_use: PortUse, ) -> Result<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, ConnectionDenied>
Callback that is invoked for every established outbound connection. Read more
§fn on_swarm_event(&mut self, event: FromSwarm<'_>)
fn on_swarm_event(&mut self, event: FromSwarm<'_>)
Informs the behaviour about an event from the
Swarm
.§fn on_connection_handler_event(
&mut self,
peer_id: PeerId,
connection_id: ConnectionId,
event: <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour,
)
fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::ToBehaviour, )
Informs the behaviour about an event generated by the
ConnectionHandler
dedicated to the peer identified by peer_id
. for the behaviour. Read more§fn poll(
&mut self,
cx: &mut Context<'_>,
) -> Poll<ToSwarm<<Toggle<TBehaviour> as NetworkBehaviour>::ToSwarm, <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>
fn poll( &mut self, cx: &mut Context<'_>, ) -> Poll<ToSwarm<<Toggle<TBehaviour> as NetworkBehaviour>::ToSwarm, <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as ConnectionHandler>::FromBehaviour>>
Polls for things that swarm should do. Read more
Auto Trait Implementations§
impl<TBehaviour> Freeze for Toggle<TBehaviour>where
TBehaviour: Freeze,
impl<TBehaviour> RefUnwindSafe for Toggle<TBehaviour>where
TBehaviour: RefUnwindSafe,
impl<TBehaviour> Send for Toggle<TBehaviour>where
TBehaviour: Send,
impl<TBehaviour> Sync for Toggle<TBehaviour>where
TBehaviour: Sync,
impl<TBehaviour> Unpin for Toggle<TBehaviour>where
TBehaviour: Unpin,
impl<TBehaviour> UnwindSafe for Toggle<TBehaviour>where
TBehaviour: UnwindSafe,
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
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
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> 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