Struct AddressList 

pub struct AddressList { /* private fields */ }

A structure to manage DAPI addresses to select from for DapiRequest execution.

Implementations

impl AddressList

pub fn new() -> AddressList

Creates an empty AddressList with default base ban time.

pub fn with_settings(base_ban_period: Duration) -> AddressList

Creates an empty AddressList with adjustable base ban time.

pub fn ban(&self, address: &Address) -> bool

Bans address Returns false if the address is not in the list.

Back-compat shim for AddressList::ban_with_reason with no reason.

pub fn ban_with_reason(&self, address: &Address, reason: Option<String>) -> bool

Bans address, recording the reason for the ban. Returns false if the address is not in the list.

pub fn ban_for( &self, address: &Address, period: Duration, reason: Option<String>, ) -> bool

Ban the address for an exact period (server-advertised); delegates to AddressStatus::ban_for — see that method for the full contract including the ban_count floor and ladder side-effect.

Returns false if the address is not in the list.

pub fn unban(&self, address: &Address) -> bool

Clears address’ ban record Returns false if the address is not in the list.

pub fn is_banned(&self, address: &Address) -> bool

Check if the address is banned.

pub fn add(&mut self, address: Address) -> bool

Adds a node Address to AddressList Returns false if the address is already in the list.

pub fn remove(&mut self, address: &Address) -> Option<AddressStatus>

Remove address from the list Returns AddressStatus if the address was in the list.

pub fn add_uri(&mut self, uri: Uri) -> bool

👎Deprecated

Add a node Address to AddressList by Uri. Returns false if the address is already in the list.

pub fn get_live_address(&self) -> Option<Address>

Randomly select a not-banned address.

An address is considered live when it has never been banned or when its ban period has already expired.

pub fn get_live_addresses(&self) -> Vec<Address>

Get all not banned addresses.

Returns a vector of addresses that are not currently banned or whose ban period has expired. The returned addresses use the same filtering logic as Self::get_live_address, checking if the ban period has expired based on the current time.

Examples

use rs_dapi_client::{AddressList, Address};

let mut list = AddressList::new();
list.add("http://127.0.0.1:3000".parse().unwrap());
list.add("http://127.0.0.1:3001".parse().unwrap());

// Get all non-banned addresses
let live_addresses = list.get_live_addresses();
assert_eq!(live_addresses.len(), 2);

pub fn ban_info(&self) -> Vec<AddressBanInfo>

Get an owned snapshot of every address’ ban state.

Clones the current state into an owned Vec<AddressBanInfo> so it can be inspected without holding the internal lock. The banned flag reflects the currently effectively banned semantics used by AddressList::get_live_address: the address has been banned at least once (ban_count > 0) and its ban period has not yet expired (banned_until is in the future).

pub fn len(&self) -> usize

Get number of all addresses, both banned and not banned.

pub fn is_empty(&self) -> bool

Check if the list is empty. Returns true if there are no addresses in the list. Returns false if there is at least one address in the list. Banned addresses are also counted.

Trait Implementations

impl Clone for AddressList

fn clone(&self) -> AddressList

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AddressList

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

Formats the value using the given formatter.

impl Default for AddressList

fn default() -> AddressList

Returns the “default value” for a type.

impl FromIterator<Address> for AddressList

fn from_iter<T>(iter: T) -> AddressList

where T: IntoIterator<Item = Address>,

Creates a value from an iterator.

impl FromStr for AddressList

type Err = AddressListError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<AddressList, <AddressList as FromStr>::Err>

Parses a string s to return a value of this type.

impl IntoIterator for AddressList

type Item = (Address, AddressStatus)

The type of the elements being iterated over.

type IntoIter = IntoIter<Address, AddressStatus>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <AddressList as IntoIterator>::IntoIter

Creates an iterator from a value.