Struct bonsaidb_core::key::OptionKeyV1

pub struct OptionKeyV1<T>(pub Option<T>);

👎Deprecated: this type should not be used in new code and should only be used in transitionary code.

A type that preserves the original implementation of Key for Option<T>. This should not be used in new code and will be removed in a future version.

Tuple Fields

0: Option<T>

👎Deprecated: this type should not be used in new code and should only be used in transitionary code.

Trait Implementations

impl<T: Clone> Clone for OptionKeyV1<T>

fn clone(&self) -> OptionKeyV1<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for OptionKeyV1<T>

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

Formats the value using the given formatter.

impl<'k, T> Key<'k> for OptionKeyV1<T>

where T: Key<'k>, Self: KeyEncoding<Self, Error = <T as KeyEncoding<T>>::Error>,

const CAN_OWN_BYTES: bool = false

If true, this type can benefit from an owned Vec<u8>. This flag is used as a hint of whether to attempt to do memcpy operations in some decoding operations to avoid extra allocations.

fn from_ord_bytes<'b>(bytes: ByteSource<'k, 'b>) -> Result<Self, Self::Error>

Deserialize a sequence of bytes previously encoded with KeyEncoding::as_ord_bytes.

fn first_value() -> Result<Self, NextValueError>

Return the first value in sequence for this type. Not all types implement this.

fn next_value(&self) -> Result<Self, NextValueError>

Return the next value in sequence for this type. Not all types implement this. Instead of wrapping/overflowing, None should be returned.

impl<K, T> KeyEncoding<OptionKeyV1<K>> for OptionKeyV1<T>

where T: KeyEncoding<K>, K: for<'k> Key<'k>,

fn as_ord_bytes(&self) -> Result<Cow<'_, [u8]>, Self::Error>

Panics

Panics if T::into_big_endian_bytes returns an empty IVec

type Error = <T as KeyEncoding<K>>::Error

The error type that can be produced by either serialization or deserialization.

const LENGTH: Option<usize> = T::LENGTH

The size of the key, if constant. If this type doesn’t produce the same number of bytes for each value, this should be None.

fn describe<Visitor>(visitor: &mut Visitor)

where Visitor: KeyVisitor,

Describes this type by invoking functions on visitor describing the key being encoded.

impl<T: PartialEq> PartialEq for OptionKeyV1<T>

fn eq(&self, other: &OptionKeyV1<T>) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Copy> Copy for OptionKeyV1<T>

impl<T: Eq> Eq for OptionKeyV1<T>

impl<T> StructuralEq for OptionKeyV1<T>

impl<T> StructuralPartialEq for OptionKeyV1<T>