Struct libp2p_swarm::behaviour::toggle::Toggle
source · 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§
source§impl<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.
sourcepub fn as_ref(&self) -> Option<&TBehaviour>
pub fn as_ref(&self) -> Option<&TBehaviour>
Returns a reference to the inner NetworkBehaviour
.
sourcepub 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§
source§impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>where
TBehaviour: NetworkBehaviour,
impl<TBehaviour> NetworkBehaviour for Toggle<TBehaviour>where TBehaviour: NetworkBehaviour,
§type ConnectionHandler = ToggleIntoConnectionHandler<<TBehaviour as NetworkBehaviour>::ConnectionHandler>
type ConnectionHandler = ToggleIntoConnectionHandler<<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.source§fn new_handler(&mut self) -> Self::ConnectionHandler
fn new_handler(&mut self) -> Self::ConnectionHandler
Creates a new
ConnectionHandler
for a connection with a peer. Read moresource§fn addresses_of_peer(&mut self, peer_id: &PeerId) -> Vec<Multiaddr>
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. Read more
source§fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
fn on_swarm_event(&mut self, event: FromSwarm<'_, Self::ConnectionHandler>)
Informs the behaviour about an event from the
Swarm
.source§fn on_connection_handler_event(
&mut self,
peer_id: PeerId,
connection_id: ConnectionId,
event: <<<Self as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)
fn on_connection_handler_event( &mut self, peer_id: PeerId, connection_id: ConnectionId, event: <<<Self as NetworkBehaviour>::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )
Informs the behaviour about an event generated by the
ConnectionHandler
dedicated to the
peer identified by peer_id
. for the behaviour. Read moresource§fn poll(
&mut self,
cx: &mut Context<'_>,
params: &mut impl PollParameters
) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>
fn poll( &mut self, cx: &mut Context<'_>, params: &mut impl PollParameters ) -> Poll<NetworkBehaviourAction<Self::OutEvent, Self::ConnectionHandler>>
Polls for things that swarm should do. Read more
source§fn inject_connection_established(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
endpoint: &ConnectedPoint,
failed_addresses: Option<&Vec<Multiaddr>>,
other_established: usize
)
fn inject_connection_established( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, endpoint: &ConnectedPoint, failed_addresses: Option<&Vec<Multiaddr>>, other_established: usize )
👎Deprecated since 0.40.2: Handle
FromSwarm::ConnectionEstablished
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Informs the behaviour about a newly established connection to a peer.
source§fn inject_connection_closed(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
endpoint: &ConnectedPoint,
handler: <Self::ConnectionHandler as IntoConnectionHandler>::Handler,
remaining_established: usize
)
fn inject_connection_closed( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, endpoint: &ConnectedPoint, handler: <Self::ConnectionHandler as IntoConnectionHandler>::Handler, remaining_established: usize )
👎Deprecated since 0.40.2: Handle
FromSwarm::ConnectionClosed
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Informs the behaviour about a closed connection to a peer. Read more
source§fn inject_address_change(
&mut self,
peer_id: &PeerId,
connection_id: &ConnectionId,
old: &ConnectedPoint,
new: &ConnectedPoint
)
fn inject_address_change( &mut self, peer_id: &PeerId, connection_id: &ConnectionId, old: &ConnectedPoint, new: &ConnectedPoint )
👎Deprecated since 0.40.2: Handle
FromSwarm::AddressChange
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Informs the behaviour that the
ConnectedPoint
of an existing connection has changed.source§fn inject_event(
&mut self,
peer_id: PeerId,
connection: ConnectionId,
event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent
)
fn inject_event( &mut self, peer_id: PeerId, connection: ConnectionId, event: <<Self::ConnectionHandler as IntoConnectionHandler>::Handler as ConnectionHandler>::OutEvent )
👎Deprecated since 0.40.2: Implement
NetworkBehaviour::on_connection_handler_event
instead. The default implementation of this inject_*
method delegates to it.Informs the behaviour about an event generated by the handler dedicated to the peer identified by
peer_id
.
for the behaviour. Read moresource§fn inject_dial_failure(
&mut self,
peer_id: Option<PeerId>,
handler: Self::ConnectionHandler,
error: &DialError
)
fn inject_dial_failure( &mut self, peer_id: Option<PeerId>, handler: Self::ConnectionHandler, error: &DialError )
👎Deprecated since 0.40.2: Handle
InEvent::DialFailure
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that the dial to a known or unknown node failed.
source§fn inject_listen_failure(
&mut self,
local_addr: &Multiaddr,
send_back_addr: &Multiaddr,
handler: Self::ConnectionHandler
)
fn inject_listen_failure( &mut self, local_addr: &Multiaddr, send_back_addr: &Multiaddr, handler: Self::ConnectionHandler )
👎Deprecated since 0.40.2: Handle
FromSwarm::ListenFailure
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that an error happened on an incoming connection during its
initial handshake. Read more
source§fn inject_new_listener(&mut self, id: ListenerId)
fn inject_new_listener(&mut self, id: ListenerId)
👎Deprecated since 0.40.2: Handle
FromSwarm::NewListener
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that a new listener was created.
source§fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
fn inject_new_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
👎Deprecated since 0.40.2: Handle
FromSwarm::NewListenAddr
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that we have started listening on a new multiaddr.
source§fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
fn inject_expired_listen_addr(&mut self, id: ListenerId, addr: &Multiaddr)
👎Deprecated since 0.40.2: Handle
FromSwarm::ExpiredListenAddr
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that a multiaddr we were listening on has expired,
which means that we are no longer listening on it.
source§fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))
fn inject_listener_error(&mut self, id: ListenerId, err: &(dyn Error + 'static))
👎Deprecated since 0.40.2: Handle
FromSwarm::ListenerError
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.A listener experienced an error.
source§fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)
fn inject_listener_closed(&mut self, id: ListenerId, reason: Result<(), &Error>)
👎Deprecated since 0.40.2: Handle
FromSwarm::ListenerClosed
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.A listener closed.
source§fn inject_new_external_addr(&mut self, addr: &Multiaddr)
fn inject_new_external_addr(&mut self, addr: &Multiaddr)
👎Deprecated since 0.40.2: Handle
FromSwarm::NewExternalAddr
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that we have discovered a new external address for us.
source§fn inject_expired_external_addr(&mut self, addr: &Multiaddr)
fn inject_expired_external_addr(&mut self, addr: &Multiaddr)
👎Deprecated since 0.40.2: Handle
FromSwarm::ExpiredExternalAddr
in NetworkBehaviour::on_swarm_event
instead. The default implementation of this inject_*
method delegates to it.Indicates to the behaviour that an external address was removed.
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§
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