Struct StoreHandle 

pub struct StoreHandle<T> { /* private fields */ }

StoreHandle acts as a container that holds store data in memory and provides methods to access and modify this data. The StoreHandle does not manage storage directly but facilitates the read and write operations by holding the data and its identifier.

Implementations

impl<T: Storing> StoreHandle<T>

pub fn new(store_id: &str) -> Self

Creates a new StoreHandle instance with the given store_id.

Arguments

• store_id - A string slice that holds the identifier for the store.

Returns

A new StoreHandle instance with the specified store_id and a default store.

Examples found in repository

examples/handle/main.rs (line 20)

fn main() {
    // Initialize the Storage with the defaults
    let storage = Storage::new("com.github.mazynoah.storage");

    // Create a handle for managing the store data.
    let mut handle = StoreHandle::<MyStore>::new("handle");

    // Read existing store from storage
    storage
        .read(&mut handle)
        .expect("Failed to read from storage");

    // Modify the store data
    let counter = handle.get_store_mut();

    counter.increment_count();
    counter.increment_count();
    counter.increment_count();

    // Write changes to disk
    storage
        .write(&mut handle)
        .expect("Failed to write to storage");

    let counter = handle.get_store();

    println!("Count: {}", counter.count);
}

pub fn get_store_mut(&mut self) -> &mut T

Returns a mutable reference to the stored data.

Returns

A mutable reference to the stored data.

Examples found in repository

examples/handle/main.rs (line 28)

fn main() {
    // Initialize the Storage with the defaults
    let storage = Storage::new("com.github.mazynoah.storage");

    // Create a handle for managing the store data.
    let mut handle = StoreHandle::<MyStore>::new("handle");

    // Read existing store from storage
    storage
        .read(&mut handle)
        .expect("Failed to read from storage");

    // Modify the store data
    let counter = handle.get_store_mut();

    counter.increment_count();
    counter.increment_count();
    counter.increment_count();

    // Write changes to disk
    storage
        .write(&mut handle)
        .expect("Failed to write to storage");

    let counter = handle.get_store();

    println!("Count: {}", counter.count);
}

pub fn get_store(&self) -> &T

Returns a reference to the stored data.

Returns

A reference to the stored data.

Examples found in repository

examples/handle/main.rs (line 39)

fn main() {
    // Initialize the Storage with the defaults
    let storage = Storage::new("com.github.mazynoah.storage");

    // Create a handle for managing the store data.
    let mut handle = StoreHandle::<MyStore>::new("handle");

    // Read existing store from storage
    storage
        .read(&mut handle)
        .expect("Failed to read from storage");

    // Modify the store data
    let counter = handle.get_store_mut();

    counter.increment_count();
    counter.increment_count();
    counter.increment_count();

    // Write changes to disk
    storage
        .write(&mut handle)
        .expect("Failed to write to storage");

    let counter = handle.get_store();

    println!("Count: {}", counter.count);
}

pub fn store_id(&self) -> &str

Returns a reference to the store identifier.

Returns

A reference to the store identifier.

Trait Implementations

impl<T: Clone> Clone for StoreHandle<T>

fn clone(&self) -> StoreHandle<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for StoreHandle<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for StoreHandle<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for StoreHandle<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.