Struct KvReader

pub struct KvReader<K> { /* private fields */ }

A reader of obkv databases.

Implementations

impl<K> KvReader<K>

pub fn from_slice(bytes: &[u8]) -> &KvReader<K>

Construct a reader on top of a memory area.

use obkv::KvReaderU16;

let reader = KvReaderU16::from_slice(&[][..]);
let mut iter = reader.iter();
assert_eq!(iter.next(), None);

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

where K: Key + PartialOrd,

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

use obkv::{KvWriterU16, KvReaderU16};

let mut writer = KvWriterU16::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: &KvReaderU16 = obkv[..].into();
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<'_, K>>

where K: Key,

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

use obkv::{KvWriterU16, KvReaderU16};

let mut writer = KvWriterU16::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: &KvReaderU16 = obkv[..].into();
let mut iter = reader.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?

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

Converts a KvReader to a byte slice.

pub fn boxed(&self) -> Box<Self>

Converts a KvReader to a boxed KvReader.

Trait Implementations

impl<K: Debug> Debug for KvReader<K>

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

Formats the value using the given formatter.

impl<'a, K> From<&'a [u8]> for &'a KvReader<K>

Construct a reader on top of a memory area.

use obkv::KvReaderU16;

let reader: &KvReaderU16 = [][..].into();
let mut iter = reader.iter();
assert_eq!(iter.next(), None);

fn from(bytes: &'a [u8]) -> Self

Converts to this type from the input type.

impl<K> From<Box<[u8]>> for Box<KvReader<K>>

Construct a reader on top of a memory area.

use obkv::KvReaderU16;

let reader: Box<KvReaderU16> = Vec::new().into_boxed_slice().into();
let mut iter = reader.iter();
assert_eq!(iter.next(), None);

fn from(boxed_bytes: Box<[u8]>) -> Self

Converts to this type from the input type.

impl<K: Hash> Hash for KvReader<K>

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

Feeds this value into the given Hasher.

impl<'a, K: Key> IntoIterator for &'a KvReader<K>

type Item = (K, &'a [u8])

The type of the elements being iterated over.

type IntoIter = Fuse<KvIter<'a, K>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<K: PartialEq> PartialEq for KvReader<K>

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl<K: Eq> Eq for KvReader<K>

impl<K> StructuralPartialEq for KvReader<K>