Struct jammdb::BucketName

pub struct BucketName<'b, 'tx> { /* private fields */ }

Bucket name

This data type signifies that a given key is associated with a nested bucket. You can access the key using the name function. The BucketData itself can be used to retreive the bucket using the get_bucket function without copying the bytes for the key.

Examples

use jammdb::{DB, Data};

let db = DB::open("my.db")?;
let mut tx = db.tx(true)?;
let bucket = tx.create_bucket("my-bucket")?;

bucket.create_bucket("my-nested-bucket")?;
if let Some(data) = bucket.get("my-nested-bucket") {
    if let Data::Bucket(b) = data {
        let name: &[u8] = b.name();
        assert_eq!(name, b"my-nested-bucket");
        let nested_bucket = bucket.get_bucket(&b).unwrap();
    }
}

Implementations

impl<'b, 'tx> BucketName<'b, 'tx>

pub fn name(&self) -> &[u8]

Returns the name of the bucket as a byte slice.

Trait Implementations

impl<'b, 'tx> Clone for BucketName<'b, 'tx>

fn clone(&self) -> BucketName<'b, 'tx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'b, 'tx> Debug for BucketName<'b, 'tx>

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

Formats the value using the given formatter.

impl<'b, 'tx> PartialEq for BucketName<'b, 'tx>

fn eq(&self, other: &BucketName<'b, 'tx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'b, 'tx> ToBytes<'tx> for &BucketName<'b, 'tx>

fn to_bytes(self) -> Bytes<'tx>

impl<'b, 'tx> ToBytes<'tx> for BucketName<'b, 'tx>

fn to_bytes(self) -> Bytes<'tx>

impl<'b, 'tx> Eq for BucketName<'b, 'tx>

impl<'b, 'tx> StructuralEq for BucketName<'b, 'tx>

impl<'b, 'tx> StructuralPartialEq for BucketName<'b, 'tx>