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>

source

pub fn is_enabled(&self) -> bool

Returns true if Toggle is enabled and false if it’s disabled.

source

pub fn as_ref(&self) -> Option<&TBehaviour>

Returns a reference to the inner NetworkBehaviour.

source

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

Returns a mutable reference to the inner NetworkBehaviour.

Trait Implementations§

source§

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

source§

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

Converts to this type from the input type.
source§

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.
source§

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. Read more
source§

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. Read more
source§

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. Read more
source§

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. Read more
source§

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

Informs the behaviour about an event from the Swarm.
source§

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. Read more
source§

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

Polls for things that swarm should do. 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§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more