Struct Tdb

pub struct Tdb(/* private fields */);

A handle to a TDB database.

Implementations

impl Tdb

pub fn open<P: AsRef<Path>>( name: P, hash_size: Option<u32>, tdb_flags: Flags, open_flags: i32, mode: c_uint, ) -> Option<Tdb>

Open the database and creating it if necessary.

Arguments

• name - The name of the db to open.
• hash_size - The hash size is advisory, leave None for a default.
• tdb_flags The flags to use to open the db:
• open_flags Flags for the open(2) function.
• mode The mode to use for the open(2) function.

pub fn memory(hash_size: Option<u32>, tdb_flags: Flags) -> Option<Tdb>

Create a database in memory

Arguments

• hash_size - The hash size is advisory, leave None for a default.
• tdb_flags The flags to use to open the db:

pub fn set_max_dead(&mut self, max_dead: u32)

Set the maximum number of dead records per hash chain.

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

Reopen the database

This can be used to reopen a database after a fork, to ensure that we have an independent seek pointer and to re-establish any locks.

pub fn fetch(&self, key: &[u8]) -> Result<Option<Vec<u8>>, Error>

Fetch a value from the database.

Arguments

• key - The key to fetch.

Returns

• Ok(Some(value)) - The value associated with the key.
• Ok(None) - The key was not found.
• Err(e) - An error occurred.

pub fn store( &mut self, key: &[u8], val: &[u8], flags: Option<StoreFlags>, ) -> Result<(), Error>

Store a key/value pair in the database.

Arguments

• key - The key to store.
• val - The value to store.
• flags - The flags to use when storing the value.

pub fn delete(&mut self, key: &[u8]) -> Result<(), Error>

Delete a key from the database.

Arguments

• key - The key to delete

pub fn append(&mut self, key: &[u8], val: &[u8]) -> Result<(), Error>

Append a value to an existing key.

Arguments

• key - The key to append to.
• val - The value to append.

pub fn keys(&self) -> impl Iterator<Item = Vec<u8>> + '_

Iterate over all keys in the database.

pub fn iter(&self) -> impl Iterator<Item = (Vec<u8>, Vec<u8>)> + '_

Iterate over all key/value pairs in the database.

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

Check if a particular key exists

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

Lock the database

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

Unlock the database

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

Lock the database, non-blocking

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

Lock the database for reading

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

Lock the database for reading, non-blocking

pub fn name(&self) -> &str

Return the name of the database

pub fn hash_size(&self) -> u32

Return the hash size used by the database

pub fn map_size(&self) -> u32

Return the map size used by the database

pub fn get_seqnum(&self) -> u64

Return the current sequence number

pub fn get_flags(&self) -> Flags

Return the current flags

pub fn add_flags(&mut self, flags: Flags)

Add a flag

pub fn remove_flags(&mut self, flags: Flags)

Remove a flag

pub fn enable_seqnum(&mut self)

Enable sequence numbers

pub fn increment_seqnum_nonblock(&mut self)

Increment the sequence number

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

Repack the database

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

Wipe the database

pub fn summary(&self) -> String

Return a string summarizing the database

pub fn freelist_size(&self) -> u32

Return the freelist size

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

Start a new transaction

pub fn transaction_active(&self) -> bool

Check if a transaction is active

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

Start a new transaction, non-blocking

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

Prepare to commit a transaction

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

Commit a transaction

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

Cancel a transaction

Trait Implementations

impl AsRawFd for Tdb

fn as_raw_fd(&self) -> RawFd

Extracts the raw file descriptor.

impl Drop for Tdb

fn drop(&mut self)

Executes the destructor for this type.