Struct szafka::Szafka

pub struct Szafka<T> {
    pub path: PathBuf,
    // some fields omitted
}

Fields

path: PathBuf

Implementations

impl<T: DeserializeOwned + Serialize> Szafka<T>

pub fn new(path: impl AsRef<Path>) -> Self

pub fn save(&self, data: &T) -> Result<(), Error>

Overwrite the existing data

Examples

use szafka::Szafka;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Serialize, Deserialize)]
struct Something {
    name: String,
    id: u64,
}

let szafka = Szafka::new("/tmp/welcome-to-szafka");
let something = Something {
    name: String::from("John"),
    id: 1000,
};
szafka.save(&something).expect("save failed");

pub fn get(&self) -> Result<T, Error>

Retrieve stored data

Examples

use szafka::Szafka;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
struct Something {
    name: String,
    id: u64,
}

let szafka = Szafka::new("/tmp/welcome-to-szafka");
let something = Something {
    name: String::from("John"),
    id: 1000,
};
szafka.save(&something).expect("save failed");
let retrieved = szafka.get().expect("get data failed");
assert_eq!(something, retrieved);

pub fn exists(&self) -> bool

Check if there is any saved data

Examples

use szafka::Szafka;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
struct Something {
    name: String,
    id: u64,
}

let szafka = Szafka::new("/tmp/welcome-to-szafka");
let something = Something {
    name: String::from("John"),
    id: 1000,
};
szafka.save(&something).expect("save failed");
assert!(szafka.exists());

pub fn remove(&self) -> Result<(), Error>

Remove stored data

Examples

use szafka::Szafka;
use serde::{Serialize, Deserialize};

#[derive(Debug, Clone, Eq, PartialEq, Serialize, Deserialize)]
struct Something {
    name: String,
    id: u64,
}

let szafka = Szafka::new("/tmp/welcome-to-szafka");
let something = Something {
    name: String::from("John"),
    id: 1000,
};
szafka.save(&something).expect("save failed");
szafka.remove().expect("remove failed");
assert!(szafka.exists() == false);

Trait Implementations

impl<T: Clone> Clone for Szafka<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Szafka<T>

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

Formats the value using the given formatter.