Struct obkv::KvReader

pub struct KvReader<'a> { /* fields omitted */ }

A reader of obkv databases.

Implementations

impl<'a> KvReader<'a>

pub fn new(bytes: &[u8]) -> KvReader<'_>

Construct a reader on top of a memory area.

use obkv::KvReader;

let mut iter = KvReader::new(&[]).iter();
assert_eq!(iter.next(), None);

pub fn get(&self, requested_key: u8) -> Option<&'a [u8]>

Returns the value associated with the given key or None if the key is not present.

use obkv::{KvWriter, KvReader};

let mut writer = KvWriter::memory();
writer.insert(0, b"hello").unwrap();
writer.insert(1, b"blue").unwrap();
writer.insert(255, b"world").unwrap();
let obkv = writer.into_inner().unwrap();

let reader = KvReader::new(&obkv);
assert_eq!(reader.get(0), Some(&b"hello"[..]));
assert_eq!(reader.get(1), Some(&b"blue"[..]));
assert_eq!(reader.get(10), None);
assert_eq!(reader.get(255), Some(&b"world"[..]));

pub fn iter(&self) -> Fuse<KvIter<'a>>

Returns an iterator over all the keys in the key-value store.

use obkv::{KvWriter, KvReader};

let mut writer = KvWriter::memory();
writer.insert(0, b"hello").unwrap();
writer.insert(1, b"blue").unwrap();
writer.insert(255, b"world").unwrap();
let obkv = writer.into_inner().unwrap();

let mut iter = KvReader::new(&obkv).iter();
assert_eq!(iter.next(), Some((0, &b"hello"[..])));
assert_eq!(iter.next(), Some((1, &b"blue"[..])));
assert_eq!(iter.next(), Some((255, &b"world"[..])));
assert_eq!(iter.next(), None);
assert_eq!(iter.next(), None); // is it fused?

Trait Implementations

impl<'a> Clone for KvReader<'a>

fn clone(&self) -> KvReader<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for KvReader<'a>

impl<'a> Debug for KvReader<'a>

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

Formats the value using the given formatter.

impl<'a> Default for KvReader<'a>

fn default() -> KvReader<'a>

Returns the "default value" for a type.

impl<'a> Eq for KvReader<'a>

impl<'a> Hash for KvReader<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> PartialEq<KvReader<'a>> for KvReader<'a>

fn eq(&self, other: &KvReader<'a>) -> bool

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

fn ne(&self, other: &KvReader<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for KvReader<'a>

impl<'a> StructuralPartialEq for KvReader<'a>