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 async 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 async fn peer_count(&self) -> usize

pub async fn get_all_addrs(&self) -> Vec<Multiaddr>

pub async fn remove_peer(&self, peer_id: &PeerId)

Remove a peer from the cache. This does not update the cache on disk.

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

Add an address to the cache

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

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

pub async fn sync_and_flush_to_disk(&self) -> Result<()>

Flush the cache to disk after syncing with the CacheData from the file.

pub async 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.

pub fn cache_file_name(local: bool) -> String

Returns the name of the cache filename based on the local flag

pub fn sync_and_flush_periodically(&self) -> JoinHandle<()>

Runs the sync_and_flush_to_disk method periodically This is useful for keeping the cache up-to-date without blocking the main thread.

Trait Implementations

impl Clone for BootstrapCacheStore

fn clone(&self) -> BootstrapCacheStore

Returns a duplicate 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.