Struct bbolt_rs::TxRwRef

pub struct TxRwRef<'tx> { /* private fields */ }

Read/Write Transaction reference used in managed transactions

Trait Implementations

impl<'tx> TxApi<'tx> for TxRwRef<'tx>

fn id(&self) -> TxId

Returns the transaction id.

fn size(&self) -> u64

Returns current database size in bytes as seen by this transaction.

fn writable(&self) -> bool

Returns whether the transaction can perform write operations.

fn cursor(&self) -> CursorImpl<'tx>

Creates a cursor associated with the root bucket. All items in the cursor will return None value because all root bucket keys point to buckets.

fn stats(&self) -> Arc<TxStats>

Retrieves a copy of the current transaction statistics.

fn bucket<T: AsRef<[u8]>>(&self, name: T) -> Option<BucketImpl<'tx>>

Retrieves a bucket by name. Returns None if the bucket does not exist.

fn for_each<F: FnMut(&[u8], BucketImpl<'tx>) -> Result<()>>( &self, f: F ) -> Result<()>

Executes a function for each key/value pair in a bucket. Because ForEach uses a Cursor, the iteration over keys is in lexicographical order.

fn page(&self, id: PgId) -> Option<PageInfo>

Returns page information for a given page number.

impl<'tx> TxRwRefApi<'tx> for TxRwRef<'tx>

fn bucket_mut<T: AsRef<[u8]>>(&mut self, name: T) -> Option<BucketRwImpl<'tx>>

Retrieves a mutable bucket by name.

fn create_bucket<T: AsRef<[u8]>>( &mut self, name: T ) -> Result<BucketRwImpl<'tx>>

Creates a new bucket.

fn create_bucket_if_not_exists<T: AsRef<[u8]>>( &mut self, name: T ) -> Result<BucketRwImpl<'tx>>

Creates a new bucket if it doesn’t already exist.

fn delete_bucket<T: AsRef<[u8]>>(&mut self, name: T) -> Result<()>

DeleteBucket deletes a bucket. Returns an error if the bucket cannot be found or if the key represents a non-bucket value.

fn on_commit<F: FnOnce() + 'tx>(&mut self, f: F)

OnCommit adds a handler function to be executed after the transaction successfully commits.