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

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§

source§

impl<NullHandling> CompositeKeyEncoder<NullHandling>where NullHandling: CompositeKeyNullHandler,

source

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");
source

pub fn finish(self) -> Vec<u8>

Finishes encoding the field and returns the encoded bytes.

source§

impl CompositeKeyEncoder<AllowNullBytes>

source

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.

source§

impl CompositeKeyEncoder<DenyNullBytes>

source

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§

source§

impl Default for CompositeKeyEncoder<EscapeNullBytes>

source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<NullHandling> RefUnwindSafe for CompositeKeyEncoder<NullHandling>where NullHandling: RefUnwindSafe,

§

impl<NullHandling> Send for CompositeKeyEncoder<NullHandling>where NullHandling: Send,

§

impl<NullHandling> Sync for CompositeKeyEncoder<NullHandling>where NullHandling: Sync,

§

impl<NullHandling> Unpin for CompositeKeyEncoder<NullHandling>where NullHandling: Unpin,

§

impl<NullHandling> UnwindSafe for CompositeKeyEncoder<NullHandling>where NullHandling: UnwindSafe,

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more