Struct Config

pub struct Config { /* private fields */ }

Available on crate feature peer-store only.

Config for MemoryStore. The available options are documented via their setters.

Implementations

impl Config

pub fn record_capacity(&self) -> &NonZero<usize>

pub fn set_record_capacity(self, capacity: NonZero<usize>) -> Config

The capacity of an address store.

The least active address will be discarded to make room for new address.

8 by default.

pub fn is_remove_addr_on_dial_error(&self) -> bool

pub fn set_remove_addr_on_dial_error(self, value: bool) -> Config

If set to true, the store will remove addresses if the swarm indicates a dial failure. More specifically:

• Failed dials indicated in ConnectionEstablished’s failed_addresses will be removed.
• DialError::LocalPeerId causes the full peer entry to be removed.
• On DialError::WrongPeerId, the address will be removed from the incorrect peer’s record and re-added to the correct peer’s record.
• On DialError::Transport, all failed addresses will be removed.

If set to false, the logic above is not applied and the store only removes addresses through calls to MemoryStore::remove_address.

true by default.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.