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
sourceimpl<TBehaviour> Toggle<TBehaviour>
impl<TBehaviour> Toggle<TBehaviour>
sourcepub fn is_enabled(&self) -> bool
pub fn is_enabled(&self) -> bool
Returns true
if Toggle
is enabled and false
if it’s disabled.
Trait Implementations
sourceimpl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour> where
TBehaviour: NetworkBehaviour,
impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour> where
TBehaviour: NetworkBehaviour,
type ConnectionHandler = ToggleIntoProtoHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>
type ConnectionHandler = ToggleIntoProtoHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>
Handler for all the protocols the network behaviour supports.
type OutEvent = <TBehaviour as NetworkBehaviour>::OutEvent
type OutEvent = <TBehaviour as NetworkBehaviour>::OutEvent
Event generated by the NetworkBehaviour
and that the swarm will report back.
sourcefn new_handler(
&mut self
) -> <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler
fn new_handler(
&mut self
) -> <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler
Creates a new ConnectionHandler
for a connection with a peer. Read more
sourcefn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr, Global>ⓘNotable traits for Vec<u8, A>impl<A> Write for Vec<u8, A> where
A: Allocator,
A: Allocator,
Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer. Read more
sourcefn inject_connection_established(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
endpoint: &ConnectedPoint,
errors: Option<&Vec<Multiaddr, Global>>,
other_established: usize
)
fn inject_connection_established(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
endpoint: &ConnectedPoint,
errors: Option<&Vec<Multiaddr, Global>>,
other_established: usize
)
Informs the behaviour about a newly established connection to a peer.
sourcefn inject_connection_closed(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
endpoint: &ConnectedPoint,
handler: <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler,
remaining_established: usize
)
fn inject_connection_closed(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
endpoint: &ConnectedPoint,
handler: <<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler,
remaining_established: usize
)
Informs the behaviour about a closed connection to a peer. Read more
sourcefn inject_address_change(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
old: &ConnectedPoint,
new: &ConnectedPoint
)
fn inject_address_change(
&mut self,
peer_id: &PeerId,
connection: &ConnectionId,
old: &ConnectedPoint,
new: &ConnectedPoint
)
Informs the behaviour that the ConnectedPoint
of an existing connection has changed.
sourcefn inject_event(
&mut self,
peer_id: PeerId,
connection: ConnectionId,
event: <<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)
fn inject_event(
&mut self,
peer_id: PeerId,
connection: ConnectionId,
event: <<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)
Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id
.
for the behaviour. Read more
sourcefn inject_dial_failure(
&mut self,
peer_id: Option<PeerId>,
handler: <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler,
error: &DialError
)
fn inject_dial_failure(
&mut self,
peer_id: Option<PeerId>,
handler: <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler,
error: &DialError
)
Indicates to the behaviour that the dial to a known or unknown node failed.
sourcefn inject_listen_failure(
&mut self,
local_addr: &Multiaddr,
send_back_addr: &Multiaddr,
handler: <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler
)
fn inject_listen_failure(
&mut self,
local_addr: &Multiaddr,
send_back_addr: &Multiaddr,
handler: <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler
)
Indicates to the behaviour that an error happened on an incoming connection during its initial handshake. Read more
sourcefn inject_new_listener(&mut self, id: ListenerId)
fn inject_new_listener(&mut self, id: ListenerId)
Indicates to the behaviour that a new listener was created.
sourcefn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
Indicates to the behaviour that we have started listening on a new multiaddr.
sourcefn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
Indicates to the behaviour that a multiaddr we were listening on has expired, which means that we are no longer listening in it. Read more
sourcefn inject_new_external_addr(&mut self, addr: &Multiaddr)
fn inject_new_external_addr(&mut self, addr: &Multiaddr)
Indicates to the behaviour that we have discovered a new external address for us.
sourcefn inject_expired_external_addr(&mut self, addr: &Multiaddr)
fn inject_expired_external_addr(&mut self, addr: &Multiaddr)
Indicates to the behaviour that an external address was removed.
sourcefn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))
fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))
A listener experienced an error.
sourcefn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)
fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)
A listener closed.
sourcefn poll(
&mut self,
cx: &mut Context<'_>,
params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<Toggle<TBehaviour> as NetworkBehaviour>::OutEvent, <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, <<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::InEvent>>
fn poll(
&mut self,
cx: &mut Context<'_>,
params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<<Toggle<TBehaviour> as NetworkBehaviour>::OutEvent, <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler, <<<Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::InEvent>>
Polls for things that swarm should do. Read more
sourceimpl<TEvent, TBehaviour> NetworkBehaviourEventProcess<TEvent> for Toggle<TBehaviour> where
TBehaviour: NetworkBehaviourEventProcess<TEvent>,
impl<TEvent, TBehaviour> NetworkBehaviourEventProcess<TEvent> for Toggle<TBehaviour> where
TBehaviour: NetworkBehaviourEventProcess<TEvent>,
sourcefn inject_event(&mut self, event: TEvent)
fn inject_event(&mut self, event: TEvent)
Called when one of the fields of the type you’re deriving NetworkBehaviour
on generates
an event. Read more
Auto Trait Implementations
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more