Struct tinycdb::CdbCreator

pub struct CdbCreator { /* fields omitted */ }

The CdbCreator struct is used while building a new CDB instance.

Implementations

impl CdbCreator

pub fn add(&mut self, key: &[u8], val: &[u8]) -> CdbResult<()>

add(key, val) adds the given key/value pair to the database, silently overwriting any previously-existing value. It returns whether or not the operation succeeded. Note that if this call panics, it is unsafe to continue building the database.

pub fn exists(&mut self, key: &[u8]) -> CdbResult<bool>

exists(key) checks whether the given key exists within the database. Note that this may slow down creation, as it results in the underlying C library flushing the internal buffer to disk on every call.

pub fn remove(&mut self, key: &[u8], zero: bool) -> CdbResult<bool>

remove(key) will remove the given key from the database. If the zero parameter is true, then an existing key/value pair will be zeroed out in the database. This prevents it from being found in normal lookups, but it will still be present in sequential scans of the database. If the zero parameter is false, then the entire record will be removed from the database. Note, however, that removing a record also involves moving other records in the database, and may take much longer to complete. Note that a remove() of the most recently-added key, regardless of the the zero parameter, will always remove it from the database entirely. The return value from this function indicates whether or not any keys were removed.

pub fn put(
    &mut self,
    key: &[u8],
    val: &[u8],
    mode: CdbPutMode
) -> CdbResult<bool>

put(key, val, mode) will add a new key to the database, with a configurable behaviour if the key already exists. See the documentation on CdbPutMode for more information on the options available. The return value from this function indicates whether or not any existing keys were found in the database during the put operation.

Trait Implementations

impl Drop for CdbCreator

fn drop(&mut self)

Executes the destructor for this type.