Struct Toggle 

pub struct Toggle<TBehaviour> { /* private fields */ }

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>

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>

Returns a reference to the inner NetworkBehaviour.

pub fn as_mut(&mut self) -> Option<&mut TBehaviour>

Returns a mutable reference to the inner NetworkBehaviour.

Trait Implementations

impl<TBehaviour> From<Option<TBehaviour>> for Toggle<TBehaviour>

fn from(inner: Option<TBehaviour>) -> Self

Converts to this type from the input type.

impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>

where TBehaviour: NetworkBehaviour,

type ProtocolsHandler = ToggleIntoProtoHandler<<TBehaviour as NetworkBehaviour>::ProtocolsHandler>

Handler for all the protocols the network behaviour supports.

type OutEvent = <TBehaviour as NetworkBehaviour>::OutEvent

Event generated by the NetworkBehaviour and that the swarm will report back.

fn new_handler(&mut self) -> Self::ProtocolsHandler

Creates a new ProtocolsHandler for a connection with a peer.

fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr>

Addresses that this behaviour is aware of for this specific peer, and that may allow reaching the peer.

fn inject_connected(&mut self, peer_id: &PeerId)

Indicate to the behaviour that we connected to the node with the given peer id.

fn inject_disconnected(&mut self, peer_id: &PeerId)

Indicates to the behaviour that we disconnected from the node with the given peer id.

fn inject_connection_established( &mut self, peer_id: &PeerId, connection: &ConnectionId, endpoint: &ConnectedPoint, )

Informs the behaviour about a newly established connection to a peer.

fn inject_connection_closed( &mut self, peer_id: &PeerId, connection: &ConnectionId, endpoint: &ConnectedPoint, )

Informs the behaviour about a closed connection to a peer.

fn inject_event( &mut self, peer_id: PeerId, connection: ConnectionId, event: <<Self::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::OutEvent, )

Informs the behaviour about an event generated by the handler dedicated to the peer identified by peer_id. for the behaviour.

fn inject_addr_reach_failure( &mut self, peer_id: Option<&PeerId>, addr: &Multiaddr, error: &dyn Error, )

Indicates to the behaviour that we tried to reach an address, but failed.

fn inject_dial_failure(&mut self, peer_id: &PeerId)

Indicates to the behaviour that we tried to dial all the addresses known for a node, but failed.

fn inject_new_listen_addr(&mut self, addr: &Multiaddr)

Indicates to the behaviour that we have started listening on a new multiaddr.

fn inject_expired_listen_addr(&mut self, addr: &Multiaddr)

Indicates to the behaviour that a new multiaddr we were listening on has expired, which means that we are no longer listening in it.

fn inject_new_external_addr(&mut self, addr: &Multiaddr)

Indicates to the behaviour that we have discovered a new external address for us.

fn poll( &mut self, cx: &mut Context<'_>, params: &mut impl PollParameters, ) -> Poll<NetworkBehaviourAction<<<Self::ProtocolsHandler as IntoProtocolsHandler>::Handler as ProtocolsHandler>::InEvent, Self::OutEvent>>

Polls for things that swarm should do.

fn inject_address_change( &mut self, _: &PeerId, _: &ConnectionId, _old: &ConnectedPoint, _new: &ConnectedPoint, )

Informs the behaviour that the ConnectedPoint of an existing connection has changed.

fn inject_listener_error( &mut self, _id: ListenerId, _err: &(dyn Error + 'static), )

A listener experienced an error.

fn inject_listener_closed( &mut self, _id: ListenerId, _reason: Result<(), &Error>, )

A listener closed.

impl<TEvent, TBehaviour> NetworkBehaviourEventProcess<TEvent> for Toggle<TBehaviour>

where TBehaviour: NetworkBehaviourEventProcess<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.