Struct bonsaidb_core::key::CompositeKeyEncoder

pub struct CompositeKeyEncoder<NullHandling = EscapeNullBytes> { /* private fields */ }

Encodes multiple KeyEncoding implementors into a single byte buffer, preserving the ordering guarantees necessary for Key.

The produced bytes can be decoded using CompositeKeyDecoder.

Implementations

impl<NullHandling> CompositeKeyEncoder<NullHandling>

where NullHandling: CompositeKeyNullHandler,

pub fn encode<'k, K: Key<'k>, T: KeyEncoding<K> + ?Sized>( &mut self, value: &'k T ) -> Result<(), CompositeKeyError>

Encodes a single KeyEncoding implementing value.

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) -> Vec<u8>

Finishes encoding the field and returns the encoded bytes.

impl CompositeKeyEncoder<AllowNullBytes>

pub const fn allowing_null_bytes() -> Self

Returns an encoder that allows null bytes in variable length fields.

See CompositeKeyFieldContainsNullByte for information about the edge cases this may introduce.

impl CompositeKeyEncoder<DenyNullBytes>

pub const fn denying_null_bytes() -> Self

Returns an encoder that denies null bytes in variable length fields by returning an error when any null bytes are detected.

Trait Implementations

impl Default for CompositeKeyEncoder<EscapeNullBytes>

fn default() -> Self

Returns the “default value” for a type.