Enum bonsaidb_core::key::KeyDescription

pub enum KeyDescription {
    Basic(KeyKind),
    Composite(CompositeKeyDescription),
    Other(Cow<'static, str>),
}

A description of an encoded Key.

Variants

Basic(KeyKind)

A basic key type.

Composite(CompositeKeyDescription)

A composite key made up of more than one field.

Other(Cow<'static, str>)

Another type with a custom encoding format.

Implementations

impl KeyDescription

pub fn for_encoding<KE: KeyEncoding<K>, K: for<'k> Key<'k> + 'static>() -> Self

Returns a description of the given KeyEncoding implementor.

Panics

This function will panic if KE emits an imbalanced sequence of visit calls.

pub fn for_key<K: for<'k> Key<'k> + 'static>() -> Self

Returns the description of a given Key implementor.

Panics

This function will panic if KE emits an imbalanced sequence of visit calls.

Trait Implementations

impl Clone for KeyDescription

fn clone(&self) -> KeyDescription

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyDescription

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KeyDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for KeyDescription

fn eq(&self, other: &KeyDescription) -> 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 Serialize for KeyDescription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for KeyDescription

impl StructuralEq for KeyDescription

impl StructuralPartialEq for KeyDescription