Struct elektra::kdb::KDB

pub struct KDB { /* fields omitted */ }

General methods to access the Key database. For example usage see the Readme.

Methods

impl KDB

pub fn open<'a>() -> Result<Self, KDBError<'a>>

Opens the session with the Key database.

pub fn get<'a>(
    &mut self,
    keyset: &mut KeySet,
    key: &mut StringKey<'a>
) -> Result<bool, KDBError<'a>>

Retrieve keys in an atomic and universal way. Note that the provided keyset is modified and contains the result. The provided key is used to give a hint about which keys should be retrieved. The return value is true, if the keys were successfully retrieved and false if there were no changes to the keyset.

pub fn set<'a>(
    &mut self,
    keyset: &mut KeySet,
    key: &mut StringKey<'a>
) -> Result<bool, KDBError<'a>>

Set keys in an atomic and universal way. The provided key is used to give a hint about which keys should be stored. The return value is true on success, and false if there were no changes to the KDB.

Notes

You have to call get with keyset first.

pub fn ensure<'a>(
    &mut self,
    keyset: &mut KeySet,
    key: &mut StringKey<'a>
) -> Result<bool, KDBError<'a>>

This method can be used the given KDB handle meets certain clauses, specified in contract. The return value is true on success, and false if clauses of the contract are unmet.

pub fn as_ptr(&mut self) -> *mut KDB

Returns the raw pointer of the KDB object. Should be used with caution. In particular, the pointer should only be modified with elektra_sys::kdb* functions, but kdbClose should not be called.

Trait Implementations

impl AsRef<_KDB> for KDB

fn as_ref(&self) -> &KDB

Performs the conversion.

impl Drop for KDB

fn drop(&mut self)

Executes the destructor for this type.

impl Debug for KDB

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.