Struct libp2p_swarm::behaviour::toggle::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 ConnectionHandler = ToggleConnectionHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>

Handler for all the protocols the network behaviour supports.

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>

Callback that is invoked for every new inbound connection.

fn handle_established_inbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, local_addr: &Multiaddr, remote_addr: &Multiaddr, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established inbound connection.

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.

fn handle_established_outbound_connection( &mut self, connection_id: ConnectionId, peer: PeerId, addr: &Multiaddr, role_override: Endpoint, ) -> Result<THandler<Self>, ConnectionDenied>

Callback that is invoked for every established outbound connection.

fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)

Informs the behaviour about an event from the Swarm.

fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: THandlerOutEvent<Self>, )

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

fn poll( &mut self, cx: &mut Context<'_>, params: &mut impl PollParameters, ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

Polls for things that swarm should do.