Struct rings_node::prelude::PersistenceStorage

pub struct PersistenceStorage { /* private fields */ }

StorageInstance struct

Implementations

impl KvStorage

pub async fn new_with_cap_and_path<P>(
    cap: usize,
    path: P
) -> impl Future<Output = Result<KvStorage, Error>>where
    P: AsRef<Path>,

New KvStorage

• cap: max_size in bytes
• path: db file location

pub async fn new_with_cap(
    cap: usize
) -> impl Future<Output = Result<KvStorage, Error>>

New KvStorage with default path default_path is ./

pub async fn new_with_path<P>(
    path: P
) -> impl Future<Output = Result<KvStorage, Error>>where
    P: AsRef<Path>,

New KvStorage with default capacity and specific path

• path: db file location

pub async fn new() -> impl Future<Output = Result<KvStorage, Error>>

New KvStorage

• default capacity 200 megabytes
• default path ./data

pub fn random_path(prefix: &str) -> String

Generate a random path

Trait Implementations

impl PersistenceStorageOperation for KvStorage

fn total_size<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    KvStorage: 'async_trait,

Get the storage size, if applicable.

fn prune<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    KvStorage: 'async_trait,

Prune database storage

fn clear<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    KvStorage: 'async_trait,

Clear Storage. All Entry will be deleted.

fn count<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<u64, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    KvStorage: 'async_trait,

Get the current storage usage, if applicable.

fn max_size<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<usize, Error>> + Send + 'async_trait, Global>>where
    'life0: 'async_trait,
    KvStorage: 'async_trait,

Get the maximum storage size, if applicable.

fn close<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait, Global>>where
    KvStorage: 'async_trait,

Close db instance