pub struct Behaviour<S> { /* private fields */ }
Expand description

A NetworkBehaviour that can act as an allow or block list.

Implementations§

source§

impl Behaviour<AllowedPeers>

source

pub fn allow_peer(&mut self, peer: PeerId)

Allow connections to the given peer.

source

pub fn disallow_peer(&mut self, peer: PeerId)

Disallow connections to the given peer.

All active connections to this peer will be closed immediately.

source§

impl Behaviour<BlockedPeers>

source

pub fn block_peer(&mut self, peer: PeerId)

Block connections to a given peer.

All active connections to this peer will be closed immediately.

source

pub fn unblock_peer(&mut self, peer: PeerId)

Unblock connections to a given peer.

Trait Implementations§

source§

impl<S: Debug> Debug for Behaviour<S>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<S: Default> Default for Behaviour<S>

source§

fn default() -> Behaviour<S>

Returns the “default value” for a type. Read more
source§

impl<S> NetworkBehaviour for Behaviour<S>where S: Enforce,

§

type ConnectionHandler = ConnectionHandler

Handler for all the protocols the network behaviour supports.
§

type ToSwarm = Void

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

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

Callback that is invoked for every established inbound connection. Read more
source§

fn handle_pending_outbound_connection( &mut self, _: ConnectionId, peer: Option<PeerId>, _: &[Multiaddr], _: Endpoint ) -> Result<Vec<Multiaddr>, ConnectionDenied>

Callback that is invoked for every outbound connection attempt. Read more
source§

fn handle_established_outbound_connection( &mut self, _: ConnectionId, peer: PeerId, _: &Multiaddr, _: 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<'_, Self::ConnectionHandler>)

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

fn on_connection_handler_event( &mut self, _id: PeerId, _: 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<'_>, _: &mut impl PollParameters ) -> Poll<ToSwarm<Self::ToSwarm, THandlerInEvent<Self>>>

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

Auto Trait Implementations§

§

impl<S> RefUnwindSafe for Behaviour<S>where S: RefUnwindSafe,

§

impl<S> Send for Behaviour<S>where S: Send,

§

impl<S> Sync for Behaviour<S>where S: Sync,

§

impl<S> Unpin for Behaviour<S>where S: Unpin,

§

impl<S> UnwindSafe for Behaviour<S>where S: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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, U> Into<U> for Twhere 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<T> for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere 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 Twhere 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.
§

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

§

fn vzip(self) -> V