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>) -> Toggle<TBehaviour>

Converts to this type from the input type.

impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>where
    TBehaviour: NetworkBehaviour,

type ConnectionHandler = ToggleIntoConnectionHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>

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
) -> <Toggle<TBehaviour> as NetworkBehaviour>::ConnectionHandler

Creates a new ConnectionHandler for a connection with a peer.

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

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

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.

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.

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.

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.

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.

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.

fn inject_new_listener(&mut self, id: ListenerId)

Indicates to the behaviour that a new listener was created.

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

Indicates to the behaviour that we have started listening on a new 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.

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

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

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

Indicates to the behaviour that an external address was removed.

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.

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.

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.