Rustbreak is an Daybreak inspired self-contained file database. It is meant to be fast and simple to use. You add it to your application and it should just work for you. The only thing you will have to take care of is saving.

When to use it

This library started out because of a need to be able to quickly write an application in rust that needed some persistence while still being able to write arbitrary data to it.

In Ruby there is Daybreak however for Rust there was no similar crate, until now!

Features

Simple To Use, Fast, Secure
Threadsafe
ron, bincode, or yaml storage

Usage

Usage is quite simple:

Create/open a database using one of the Database constructors:
- Create a FileDatabase with FileDatabase::from_path
- Create a MemoryDatabase with MemoryDatabase::memory
- Create a Database with Database::from_parts
Write/Read data from the Database
Don't forget to run sync periodically

# use std::collections::HashMap;
use rustbreak::{MemoryDatabase, deser::Ron};

let db = MemoryDatabase::<HashMap<String, String>, Ron>::memory(HashMap::new(), Ron);

println!("Writing to Database");
db.write(|db| {
    db.insert("hello".into(), String::from("world"));
    db.insert("foo".into(), String::from("bar"));
});

db.read(|db| {
    // db.insert("foo".into(), String::from("bar"));
    // The above line will not compile since we are only reading
    println!("Hello: {:?}", db.get("hello"));
});

Yaml

If you would like to use yaml instead of bincode to perhaps read or modify the database in an editor you can use it like this:

Disable default features
Specify yaml as a feature

[dependencies.rustbreak]
version = "1"
default-features = false
features = ["yaml"]

Ron

If you would like to use ron instead of bincode:

Disable default features
Specify ron_enc as a feature

[dependencies.rustbreak]
version = "1"
default-features = false
features = ["ron_enc"]