Struct JsonDB

pub struct JsonDB { /* private fields */ }

Database struct (does not use ::new instead uses ::init)

Examples

let db = JsonDB::init("your db name")?;

Note:

Does not handle errors in version “0.1.0” just passes on to user

Implementations

impl JsonDB

pub fn init(path: &str) -> Result<JsonDB, Box<dyn Error>>

Init function (takes the place of ::new)

Examples

let db = JsonDB::init("your db name")?;

pub fn create_collection<S>( self, collection_path: S, ) -> Result<JsonDB, Box<dyn Error>>

where S: Into<String>,

Creates a new collection either in your database or in another collection

Examples

db.create_collection("your collection path")?;

pub fn write<J, S>( self, collection_path: S, document: S, data: J, ) -> Result<JsonDB, Box<dyn Error>>

where J: Serialize, S: Into<String>,

Writes (or rewrites) data to document in collection

Examples

db.write("your collection path", "your document", "struct that derives serde::serialize")?;

pub fn read<D, S>( self, collection_path: S, document: S, ) -> Result<D, Box<dyn Error>>

where for<'a> D: Deserialize<'a>, S: Into<String>,

Reads data from document in collection

let data: impl serde::Deserialize = db.read("your collection path", "your document")?;

pub fn delete<S>( self, collection_path: S, document: S, ) -> Result<JsonDB, Box<dyn Error>>

where S: Into<String>,

Deletes document in collection

Examples

db.delete("your collection path", "your document")?;

pub fn list<S>(self, collection_path: S) -> Result<Vec<String>, Box<dyn Error>>

where S: Into<String>,

List all document in a collection

Examples

let list: Vec<String> = db.list("your collection path")?;