mirror of
https://github.com/Drop-OSS/dropbreak.git
synced 2026-07-21 00:05:22 -04:00
2a0899f1ee1858dbe45794d0f5e742c3d8197d6d
Rustbreak
Rustbreak is an Daybreak inspired file database. It is meant to be fast and simple to use.
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
- Key/Value Storage
Usage
Usage is quite simple:
- Create/open a database using
Database::open- You can specify the kind of Key you want using this Syntax:
Database::<Key>::open
- You can specify the kind of Key you want using this Syntax:
Insert/Retrievedata from the Database- Don't forget to run
flushperiodically
use rustbreak::Database;
fn main() {
let db = Database::open("my_contacts").unwrap();
db.insert("Lapfox", "lapfoxtrax.com").unwrap();
db.insert("Rust", "github.com/rust-lang/rust").unwrap();
// we need to be explicit about the kind of type we want as println! is
// generic
let rust : String = db.retrieve("Rust").unwrap();
println!("You can find Rust at: {}", rust);
db.flush().unwrap();
}
How it works
Internally the Database holds a Hashmap behind a RwLock. This Hashmap is then written to/read from and safely casted to the requested type. This works thanks to encoding/decoding traits.
Languages
Rust
100%