Struct BootstrapCacheConfig

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

Configuration for the bootstrap cache

Fields

addr_expiry_duration: Duration

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

backwards_compatible_writes: bool

Enable backwards compatibility while writing the cache file. This will write the cache file in all versions of the cache file format.

cache_dir: PathBuf

The directory to load and store the bootstrap cache. If not provided, the default path will be used.

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.

disable_cache_writing: bool

Flag to disable writing to the cache file

local: bool

If set to true, the cache filename will be suffixed with “_local”

max_cache_save_duration: Duration

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

max_peers: usize

Maximum number of peers to keep in the cache

max_addrs_per_peer: usize

Maximum number of addresses stored per peer.

min_cache_save_duration: Duration

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

Implementations

impl BootstrapCacheConfig

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

Creates a new BootstrapConfig with default settings

pub fn empty() -> Self

Creates a new BootstrapConfig with empty settings

pub fn with_backwards_compatible_writes(self, enable: bool) -> Self

Set backwards compatible writes

pub fn with_local(self, enable: bool) -> Self

Set the local flag

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

Set a new addr expiry duration

pub fn with_cache_dir<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 duplicate 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.