Struct BanList

pub struct BanList { /* private fields */ }

Stores peers that should be taken out of circulation either indefinitely or until a certain timestamp

Implementations

impl BanList

pub fn new( banned_peers: impl IntoIterator<Item = B512>, banned_ips: impl IntoIterator<Item = IpAddr>, ) -> Self

Creates a new ban list that bans the given peers and ips indefinitely.

pub const fn new_with_timeout( banned_peers: HashMap<B512, Option<Instant>>, banned_ips: HashMap<IpAddr, Option<Instant>>, ) -> Self

Creates a new ban list that bans the given peers and ips with an optional timeout.

pub fn evict_peers(&mut self, now: Instant) -> Vec<B512>

Removes all peers that are no longer banned.

pub fn evict_ips(&mut self, now: Instant) -> Vec<IpAddr>

Removes all ip addresses that are no longer banned.

pub fn evict(&mut self, now: Instant) -> (Vec<IpAddr>, Vec<B512>)

Removes all entries that should no longer be banned.

Returns the evicted entries.

pub fn is_banned(&self, peer_id: &B512, ip: &IpAddr) -> bool

Returns true if either the given peer id or ip address is banned.

pub fn is_banned_ip(&self, ip: &IpAddr) -> bool

checks the ban list to see if it contains the given ip

pub fn is_banned_peer(&self, peer_id: &B512) -> bool

checks the ban list to see if it contains the given ip

pub fn unban_ip(&mut self, ip: &IpAddr)

Unbans the ip address

pub fn unban_peer(&mut self, peer_id: &B512)

Unbans the ip address

pub fn ban_ip_until(&mut self, ip: IpAddr, until: Instant)

Bans the IP until the timestamp.

This does not ban non-global IPs.

pub fn ban_peer_until(&mut self, node_id: B512, until: Instant)

Bans the peer until the timestamp

pub fn ban_ip(&mut self, ip: IpAddr)

Bans the IP indefinitely.

This does not ban non-global IPs.

pub fn ban_peer(&mut self, node_id: B512)

Bans the peer indefinitely,

pub fn ban_peer_with(&mut self, node_id: B512, until: Option<Instant>)

Bans the peer indefinitely or until the given timeout.

pub fn ban_ip_with(&mut self, ip: IpAddr, until: Option<Instant>)

Bans the ip indefinitely or until the given timeout.

This does not ban non-global IPs.

Trait Implementations

impl Clone for BanList

fn clone(&self) -> BanList

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BanList

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

Formats the value using the given formatter.

impl Default for BanList

fn default() -> BanList

Returns the “default value” for a type.

impl PartialEq for BanList

fn eq(&self, other: &BanList) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BanList

impl StructuralPartialEq for BanList

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 96 bytes