Expand description

Disk Persist

CI

A library that makes it very easy for your application to keep data inbetween executions. It can (very quickly) read and write any data structure that implements serde’s Serialize and Deserialize to disk. It automatically saves the information to either the user’s cache folder or any other path that you specify.

Default Location:

PlatformValueExample
Linux$XDG_CACHE_HOME or $HOME/.cache/home/user/.cache
macOS$HOME/Library/Caches/Users/User/Library/Caches
Windows{FOLDERID_LocalAppData}C:\Users\User\AppData\Local

The Basics

Create our data:

use serde::{Deserialize, Serialize};

...

#[derive(Serialize, Deserialize, Debug)]
struct Data {
    name: String,
    age: u8,
}

Write it to disk:

let persist: DiskPersist<Data> = DiskPersist::init("disk-persist-example").unwrap();

let data = Data {
    name: "John Doe".to_string(),
    age: 45,
};

persist.write(&data).unwrap();

Then read it at any time:

let persist: DiskPersist<Data> = DiskPersist::init("disk-persist-example").unwrap();

println!("{:#?}", persist.read().unwrap());

Outputs:

Some(
    Data {
        name: "John Doe",
        age: 45,
    },
)

Structs

A struct for managing persistent data on disk

Enums

Errors returned by DiskPersist.