Struct BootstrapCacheConfig

pub struct BootstrapCacheConfig {
    pub addr_expiry_duration: Duration,
    pub max_peers: usize,
    pub max_addrs_per_peer: usize,
    pub cache_file_path: PathBuf,
    pub disable_cache_writing: bool,
    pub min_cache_save_duration: Duration,
    pub max_cache_save_duration: Duration,
    pub cache_save_scaling_factor: u64,
}

Configuration for the bootstrap cache

Fields

addr_expiry_duration: Duration

The duration since last)seen before removing the address of a Peer.

max_peers: usize

Maximum number of peers to keep in the cache

max_addrs_per_peer: usize

Maximum number of addresses stored per peer.

cache_file_path: PathBuf

Path to the bootstrap cache file

disable_cache_writing: bool

Flag to disable writing to the cache file

min_cache_save_duration: Duration

The min time duration until we save the bootstrap cache to disk.

max_cache_save_duration: Duration

The max time duration until we save the bootstrap cache to disk.

cache_save_scaling_factor: u64

The cache save scaling factor. We start with the min_cache_save_duration and scale it up to the max_cache_save_duration.

Implementations

impl BootstrapCacheConfig

pub fn default_config(local: bool) -> Result<Self>

Creates a new BootstrapConfig with default settings

When local is set to true, a different cache file name is used. I.e. the file name will include _local_ in the name.

pub fn empty() -> Self

Creates a new BootstrapConfig with empty settings

pub fn with_addr_expiry_duration(self, duration: Duration) -> Self

Set a new addr expiry duration

pub fn with_cache_path<P: AsRef<Path>>(self, path: P) -> Self

Update the config with a custom cache file path

pub fn with_max_peers(self, max_peers: usize) -> Self

Sets the maximum number of peers

pub fn with_addrs_per_peer(self, max_addrs: usize) -> Self

Sets the maximum number of addresses for a single peer.

pub fn with_disable_cache_writing(self, disable: bool) -> Self

Sets the flag to disable writing to the cache file

Trait Implementations

impl Clone for BootstrapCacheConfig

fn clone(&self) -> BootstrapCacheConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BootstrapCacheConfig

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

Formats the value using the given formatter.