Struct yedb::Database

source · [−]

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: boolauto_flush: boolwrite_modified_only: booltimeout: Durationlock_ex: boolauto_bak: u64skip_bak: Vec<String>strict_schema: bool

Implementations

source

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

source

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

Errors

Will return Err if the database is already open

source

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

source

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

Errors

Will return Err if the database is already open

source

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

Errors

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

source

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

Errors

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

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err if the database is not open

Panics

Will panic on internal errors

source

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

Errors

Will return Err on invalid property or value

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err on I/O errors

source

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

source

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

source

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

Errors

Will return Err on I/O errors

source

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

source

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

source

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

source

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

Errors

Will return Err on I/O or serialization errors

source

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

Errors

Will return Err on I/O errors

source

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

Errors

Will return Err on I/O errors

source

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

source

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

source

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

source

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

source

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

Errors

Will return Err on I/O errors

Panics

Will panic on internal path errors

source

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

source

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

Errors

Will return Err if keys are unable to be read

source

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

source

impl Default for Database

source

fn default() -> Self

Returns the “default value” for a type. Read more

source

impl Drop for Database

source

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Database

impl Send for Database

impl Sync for Database

impl Unpin for Database

impl UnwindSafe for Database

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct yedb::Database

Fields

Implementations

impl Database

pub fn new() -> Self

pub fn is_open(&self) -> bool

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Trait Implementations

impl Default for Database

fn default() -> Self

impl Drop for Database

fn drop(&mut self)

Auto Trait Implementations

impl RefUnwindSafe for Database

impl Send for Database

impl Sync for Database

impl Unpin for Database

impl UnwindSafe for Database

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,