Struct obkv::KvWriter

pub struct KvWriter<W, K> { /* fields omitted */ }

An obkv database writer.

Implementations

impl<K> KvWriter<Vec<u8>, K>

pub fn memory() -> KvWriter<Vec<u8>, K>

Creates an in memory KvWriter that writes the bytes into a Vec<u8>.

use obkv::KvWriterU16;

let mut writer = KvWriterU16::memory();

writer.insert(0, b"hello").unwrap();
writer.insert(1, b"blue").unwrap();
writer.insert(255, b"world").unwrap();

let vec = writer.into_inner().unwrap();

impl<W, K> KvWriter<W, K>

pub fn new(writer: W) -> KvWriter<W, K>

Creates a KvWriter that writes the bytes into the given io::Write type (e.g. File, Vec<u8>).

use obkv::KvWriterU16;

let mut writer = KvWriterU16::new(Vec::new());

writer.insert(0, b"hello").unwrap();
writer.insert(1, b"blue").unwrap();
writer.insert(255, b"world").unwrap();

let vec = writer.into_inner().unwrap();

impl<W: Write, K: Key + PartialOrd> KvWriter<W, K>

pub fn insert<A: AsRef<[u8]>>(&mut self, key: K, value: A) -> Result<()>

Insert a key value pair into the database, keys must be inserted in order and must be inserted only one time.

use obkv::KvWriterU16;

let mut writer = KvWriterU16::new(Vec::new());

writer.insert(0, b"hello").unwrap();
writer.insert(1, b"blue").unwrap();
writer.insert(255, b"world").unwrap();

let vec = writer.into_inner().unwrap();

pub fn extend<I, V>(&mut self, iter: I) -> Result<()> where
    I: IntoIterator<Item = (K, V)>,
    V: AsRef<[u8]>, 

Insert the key value pairs into the database, keys must be inserted in order and must be inserted only one time.

pub fn into_inner(self) -> Result<W>

Flushes then extract the internal writer that now contains the keys value entries.

pub fn finish(self) -> Result<()>

Flushes the internal writer that now contains the keys value entries.

Trait Implementations

impl<W: Clone, K: Clone> Clone for KvWriter<W, K>

fn clone(&self) -> KvWriter<W, K>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<W: Debug, K: Debug> Debug for KvWriter<W, K>

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

Formats the value using the given formatter.

impl<W: Hash, K: Hash> Hash for KvWriter<W, K>

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<W: PartialEq, K: PartialEq> PartialEq<KvWriter<W, K>> for KvWriter<W, K>

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

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

fn ne(&self, other: &KvWriter<W, K>) -> bool

This method tests for !=.

impl<W: Copy, K: Copy> Copy for KvWriter<W, K>

impl<W: Eq, K: Eq> Eq for KvWriter<W, K>

impl<W, K> StructuralEq for KvWriter<W, K>

impl<W, K> StructuralPartialEq for KvWriter<W, K>