Struct jammdb::KVPair

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

Key / Value Pair

You can use the key and value methods to access the underlying byte slices. The data is only valid for the life of the transaction, so make a copy if you want to keep it around longer than that.

Examples

use jammdb::{DB, Data};

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

// put a key / value pair into the bucket
bucket.put("my-key", "my-value")?;
if let Some(data) = bucket.get("my-key") {
    if let Data::KeyValue(kv) = data {
        let key: &[u8] = kv.key();
        let value: &[u8] = kv.value();
        assert_eq!(key, b"my-key");
        assert_eq!(value, b"my-value");
    }
}

Implementations

impl<'b, 'tx> KVPair<'b, 'tx>

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

Returns the key of the key / value pair as a byte slice.

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

Returns the value of the key / value pair as a byte slice.

pub fn kv(&self) -> (&[u8], &[u8])

Returns the key / value pair as a tuple of slices.

Trait Implementations

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

fn clone(&self) -> KVPair<'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 KVPair<'b, 'tx>

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

Formats the value using the given formatter.

impl<'b, 'tx> From<(Bytes<'tx>, Bytes<'tx>)> for KVPair<'b, 'tx>

fn from(val: (Bytes<'tx>, Bytes<'tx>)) -> Self

Converts to this type from the input type.

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

fn eq(&self, other: &KVPair<'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> Eq for KVPair<'b, 'tx>

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

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