Struct libp2p_networking::network::behaviours::dht::store::file_backed::FileBackedStore

pub struct FileBackedStore<R: RecordStore> {
    underlying_store: R,
    path: String,
    max_record_delta: u64,
    record_delta: u64,
}

A RecordStore wrapper that occasionally saves the DHT to a file on disk.

Fields

underlying_store: R

The underlying store

path: String

The path to the file

max_record_delta: u64

The maximum number of records that can be added to the store before the store is saved to a file

record_delta: u64

The running delta between the records in the file and the records in the underlying store

Implementations

impl<R: RecordStore> FileBackedStore<R>

pub fn new(underlying_store: R, path: String, max_record_delta: u64) -> Self

Create a new FileBackedStore with the given underlying store and path.

max_record_delta is the maximum number of records that can be added to the store before the store is saved to a file.

pub fn save_to_file(&mut self) -> Result<()>

Attempt to save the DHT to the file at the given path

Errors

• If we fail to serialize the DHT
• If we fail to write the serialized DHT to the file

pub fn restore_from_file(&mut self, path: String) -> Result<()>

Attempt to restore the DHT to the underlying store from the file at the given path

Errors

• If we fail to read the file
• If we fail to deserialize the file

Trait Implementations

impl<R: RecordStore> RecordStore for FileBackedStore<R>

Implement the RecordStore trait for FileBackedStore

fn put(&mut self, record: Record) -> Result<()>

Overwrite the put method to potentially save the record to a file

fn remove(&mut self, k: &RecordKey)

Overwrite the remove method to potentially remove the record from a file

type ProvidedIter<'a> = <R as RecordStore>::ProvidedIter<'a> where R: 'a

type RecordsIter<'a> = <R as RecordStore>::RecordsIter<'a> where R: 'a

fn add_provider(&mut self, record: ProviderRecord) -> Result<()>

Adds a provider record to the store.

fn get(&self, k: &RecordKey) -> Option<Cow<'_, Record>>

Gets a record from the store, given its key.

fn provided(&self) -> Self::ProvidedIter<'_>

Gets an iterator over all stored provider records for which the node owning the store is itself the provider.

fn providers(&self, key: &RecordKey) -> Vec<ProviderRecord>

Gets a copy of the stored provider records for the given key.

fn records(&self) -> Self::RecordsIter<'_>

Gets an iterator over all (value-) records currently stored.

fn remove_provider(&mut self, k: &RecordKey, p: &PeerId)

Removes a provider record from the store.