Struct bonsaidb_core::key::CompositeKeyDecoder

pub struct CompositeKeyDecoder<'key, 'ephemeral, NullHandling = EscapeNullBytes> { /* private fields */ }

Decodes multiple Key values from a byte slice previously encoded with CompositeKeyEncoder.

Implementations

impl<'key, 'ephemeral> CompositeKeyDecoder<'key, 'ephemeral, EscapeNullBytes>

pub fn default_for(bytes: ByteSource<'key, 'ephemeral>) -> Self

Returns a decoder for bytes that decodes escaped null bytes.

This function is compatible with keys encoded with CompositeKeyEncoder::default().

impl<'key, 'ephemeral> CompositeKeyDecoder<'key, 'ephemeral, AllowNullBytes>

pub fn allowing_null_bytes(bytes: ByteSource<'key, 'ephemeral>) -> Self

Returns a decoder for bytes that ignores null bytes.

This function is compatible with keys encoded with CompositeKeyEncoder::allowing_null_bytes().

impl<'key, 'ephemeral> CompositeKeyDecoder<'key, 'ephemeral, DenyNullBytes>

pub fn denying_null_bytes(bytes: ByteSource<'key, 'ephemeral>) -> Self

Returns a decoder for bytes that ignores null bytes.

This function is compatible with keys encoded with CompositeKeyEncoder::denying_null_bytes().

impl<'key, 'ephemeral, NullHandling> CompositeKeyDecoder<'key, 'ephemeral, NullHandling>

where NullHandling: CompositeKeyNullHandler,

pub fn decode<T: Key<'key>>(&mut self) -> Result<T, CompositeKeyError>

Decodes a value previously encoded using CompositeKeyEncoder. Calls to decode must be made in the same order as the values were encoded in.

let value1 = String::from("hello");
let value2 = 42_u32;
let mut encoder = CompositeKeyEncoder::default();
encoder.encode(&value1).unwrap();
encoder.encode(&value2).unwrap();
let encoded = encoder.finish();

let mut decoder = CompositeKeyDecoder::default_for(ByteSource::Borrowed(&encoded));
let decoded_string = decoder.decode::<String>().unwrap();
assert_eq!(decoded_string, value1);
let decoded_u32 = decoder.decode::<u32>().unwrap();
assert_eq!(decoded_u32, value2);
decoder.finish().expect("trailing bytes");

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

Verifies the underlying byte slice has been fully consumed.