Struct BootstrapCacheStore

pub struct BootstrapCacheStore { /* private fields */ }

Implementations

impl BootstrapCacheStore

pub fn config(&self) -> &BootstrapCacheConfig

pub fn new(config: BootstrapCacheConfig) -> Result<Self>

Create an empty CacheStore with the given configuration

pub fn new_from_initial_peers_config( init_peers_config: &InitialPeersConfig, config: Option<BootstrapCacheConfig>, ) -> Result<Self>

Create an empty CacheStore from the given Initial Peers Configuration. This also modifies the BootstrapCacheConfig if provided based on the InitialPeersConfig. And also performs some actions based on the InitialPeersConfig.

InitialPeersConfig::bootstrap_cache_dir will take precedence over the path provided inside config.

pub fn load_cache_data(cfg: &BootstrapCacheConfig) -> Result<CacheData>

Load cache data from disk Make sure to have clean addrs inside the cache as we don’t call craft_valid_multiaddr

pub fn peer_count(&self) -> usize

pub fn get_all_addrs(&self) -> impl Iterator<Item = &BootstrapAddr>

pub fn get_sorted_addrs(&self) -> impl Iterator<Item = &Multiaddr>

Get a list containing single addr per peer. We use the least faulty addr for each peer. This list is sorted by the failure rate of the addr.

pub fn update_addr_status(&mut self, addr: &Multiaddr, success: bool)

Update the status of an addr in the cache. The peer must be added to the cache first.

pub fn add_addr(&mut self, addr: Multiaddr)

Add a set of addresses to the cache.

pub fn remove_addr(&mut self, addr: &Multiaddr)

Remove a single address for a peer.

pub fn perform_cleanup(&mut self)

pub fn sync_and_flush_to_disk(&mut self, with_cleanup: bool) -> Result<()>

Flush the cache to disk after syncing with the CacheData from the file. Do not perform cleanup when data is fetched from the network. The SystemTime might not be accurate.

pub fn write(&self) -> Result<()>

Write the cache to disk atomically. This will overwrite the existing cache file, use sync_and_flush_to_disk to sync with the file first.

Trait Implementations

impl Clone for BootstrapCacheStore

fn clone(&self) -> BootstrapCacheStore

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BootstrapCacheStore

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

Formats the value using the given formatter.