Rustbreak

Build Status Crates Link

Documentation

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

Quickstart

Add this to your Cargo.toml:

toml [dependencies.rustbreak] version = "2" features = ["ron_enc"] # You can also use "yaml_enc" or "bin_enc" # Check the documentation to add your own!

```rust

extern crate failure;

extern crate rustbreak;

use std::collections::HashMap;

use rustbreak::{MemoryDatabase, deser::Ron};

fn main() {

let func = || -> Result<(), failure::Error> {

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

println!("Writing to Database"); db.write(|db| { db.insert(0, String::from("world")); db.insert(1, 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(&0)); })?;

return Ok(()); };

func().unwrap();

}

```

Usage

Usage is quite simple:

```rust

use std::collections::HashMap;

use rustbreak::{MemoryDatabase, deser::Ron};

let db = MemoryDatabase::, 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:

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

Ron

If you would like to use ron instead of bincode:

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