Struct bonsaidb_core::key::EscapeNullBytes

pub struct EscapeNullBytes;

Escapes null bytes in variable length fields in composite keys. This option ensures proper sort order is maintained even when null bytes are used within vairable fields.

To see more information about the edge case encoding prevents, see CompositeKeyFieldContainsNullByte.

Trait Implementations

impl Clone for EscapeNullBytes

fn clone(&self) -> EscapeNullBytes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompositeKeyNullHandler for EscapeNullBytes

fn handle_nulls( &self, unescaped: &mut Cow<'_, [u8]> ) -> Result<(), CompositeKeyError>

Process the null bytes in field_bytes, if needed.

fn decode_nulls_if_needed<'b, 'e>( &self, encoded: ByteSource<'b, 'e> ) -> Result<ByteSource<'b, 'e>, CompositeKeyError>

Decode the null bytes in encoded, if needed.

impl Debug for EscapeNullBytes

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

Formats the value using the given formatter.

impl Default for EscapeNullBytes

fn default() -> EscapeNullBytes

Returns the “default value” for a type.

impl Copy for EscapeNullBytes