Struct yedb::Database

pub struct Database {
    pub auto_repair: bool,
    pub auto_flush: bool,
    pub write_modified_only: bool,
    pub timeout: Duration,
    pub lock_ex: bool,
    pub auto_bak: u64,
    pub skip_bak: Vec<String>,
    pub strict_schema: bool,
    /* private fields */
}

Fields

auto_repair: bool

auto_flush: bool

write_modified_only: bool

timeout: Duration

lock_ex: bool

auto_bak: u64

skip_bak: Vec<String>

strict_schema: bool

Implementations

impl Database

pub fn new() -> Self

Examples found in repository

examples/embed.rs (line 5)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn is_open(&self) -> bool

pub fn set_default_fmt( &mut self, fmt: &str, checksums: bool ) -> Result<(), Error>

Errors

Will return Err if the database is already open or the format is unknown

pub fn set_db_path(&mut self, path: &str) -> Result<(), Error>

Errors

Will return Err if the database is already open

Examples found in repository

examples/embed.rs (line 6)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn set_cache_size(&mut self, size: usize)

pub fn set_lock_path(&mut self, path: &str) -> Result<(), Error>

Errors

Will return Err if the database is already open

pub fn open(&mut self) -> Result<ServerInfo, Error>

Errors

Will return Err on I/O errors or if the engine is not initialized

Examples found in repository

examples/embed.rs (line 7)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn close(&mut self) -> Result<(), Error>

Errors

Will return errors if the database is not opened or on I/O errors

Examples found in repository

examples/embed.rs (line 12)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn key_load_from_serialized(&mut self, data: &[Value]) -> Result<(), Error>

Errors

Will return Err on I/O errors

pub fn info(&self) -> Result<DBInfo, Error>

Errors

Will return Err if the database is not open

Panics

Will panic on internal errors

pub fn server_set(&mut self, name: &str, value: Value) -> Result<(), Error>

Errors

Will return Err on invalid property or value

pub fn purge(&mut self) -> Result<Vec<String>, Error>

Errors

Will return Err on I/O errors

pub fn safe_purge(&mut self) -> Result<(), Error>

Errors

Will return Err on I/O errors

pub fn purge_cache(&mut self) -> Result<(), Error>

Errors

Will return Err on I/O errors

pub fn key_delete(&mut self, key: &str) -> Result<(), Error>

Errors

Will return Err on I/O errors

Examples found in repository

examples/embed.rs (line 11)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn key_delete_recursive(&mut self, key: &str) -> Result<(), Error>

Errors

Will return Err on I/O errors

pub fn key_explain(&mut self, key: &str) -> Result<KeyExplained, Error>

Errors

Will return Err if the key is not found and on I/O errors

Panics

Will panic on internal errors

pub fn key_get(&mut self, key: &str) -> Result<Value, Error>

Errors

Will return Err if the key is not found and on I/O errors

Examples found in repository

examples/embed.rs (line 10)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn key_get_recursive( &mut self, key: &str ) -> Result<Vec<(String, Value)>, Error>

Errors

Will return Err on I/O errors

pub fn key_get_field(&mut self, key: &str, field: &str) -> Result<Value, Error>

Get key field

field may contain a simple path (e.g. field/subfield/subsubfield)

Errors

Will return Err if the key is not found, on I/O or serialization errors

pub fn key_set_field( &mut self, key: &str, field: &str, value: Value ) -> Result<(), Error>

Set key field

field may contain a simple path (e.g. field/subfield/subsubfield)

Errors

Will return Err on I/O or serialization errors

Panics

Will panic on internal serde errors

pub fn key_delete_field(&mut self, key: &str, field: &str) -> Result<(), Error>

Delete key field

field may contain a simple path (e.g. field/subfield/subsubfield)

Errors

Will return Err on I/O or serialization errors

pub fn key_set(&mut self, key: &str, value: Value) -> Result<(), Error>

Errors

Will return Err on I/O or serialization errors

Examples found in repository

examples/embed.rs (line 9)

fn main() {
    let mut db = Database::new();
    db.set_db_path(&"/tmp/db1").unwrap();
    db.open().unwrap();
    let key_name = "test/key1";
    db.key_set(&key_name, Value::from(123_u8)).unwrap();
    println!("{:?}", db.key_get(&key_name));
    db.key_delete(&key_name).unwrap();
    db.close().unwrap();
}

pub fn key_list(&mut self, key: &str) -> Result<Vec<String>, Error>

Errors

Will return Err on I/O errors

pub fn key_list_all(&mut self, key: &str) -> Result<Vec<String>, Error>

Errors

Will return Err on I/O errors

pub fn key_copy(&mut self, key: &str, dst_key: &str) -> Result<(), Error>

Errors

Will return Err if the key is not found or is unable to be copied

pub fn key_increment(&mut self, key: &str) -> Result<i64, Error>

Errors

Will return Err if the key is not found, is not numeric or I/O error occured

pub fn key_decrement(&mut self, key: &str) -> Result<i64, Error>

Errors

Will return Err if the key is not found, is not numeric or I/O error occured

pub fn key_rename(&mut self, key: &str, dst_key: &str) -> Result<(), Error>

Errors

Will return Err if the key is not found or is unable to be renamed

pub fn check(&mut self) -> Result<Vec<String>, Error>

Errors

Will return Err on I/O errors

Panics

Will panic on internal path errors

pub fn repair(&mut self) -> Result<Vec<(String, bool)>, Error>

Errors

Will return Err on I/O errors

Panics

Will panic on internal path errors

pub fn key_dump(&mut self, key: &str) -> Result<Vec<(String, Value)>, Error>

Errors

Will return Err if keys are unable to be read

pub fn key_load(&mut self, data: Vec<(String, Value)>) -> Result<(), Error>

Errors

Will return Err if key is not found or unable to be read

Trait Implementations

impl Default for Database

fn default() -> Self

Returns the “default value” for a type.

impl Drop for Database

fn drop(&mut self)

Executes the destructor for this type.