Struct bonsaidb_core::key::EnumKey

pub struct EnumKey<T>(pub T)
where
    T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync;

Adds Key support to an enum. Requires implementing ToPrimitive and FromPrimitive, or using a crate like num-derive to do it automatically. Take care when using enums as keys: if the order changes or if the meaning of existing numerical values changes, make sure to update any related views’ version number to ensure the values are re-evaluated.

Tuple Fields

0: T

Trait Implementations

impl<T> Clone for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + Debug,

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

Formats the value using the given formatter.

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

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync,

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<T> KeyEncoding for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync,

type Error = Error

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

const LENGTH: Option<usize> = None

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.

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

Convert self into a Cow<'_, [u8]> containing bytes that are able to be compared via memcmp in a way that is comptaible with its own Ord implementation.

impl<T> Ord for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + Ord,

fn cmp(&self, other: &EnumKey<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + PartialEq,

fn eq(&self, other: &EnumKey<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> PartialOrd for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + PartialOrd,

fn partial_cmp(&self, other: &EnumKey<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> Copy for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + Copy,

impl<T> Eq for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync + Eq,

impl<T> StructuralEq for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync,

impl<T> StructuralPartialEq for EnumKey<T>

where T: ToPrimitive + FromPrimitive + Clone + Eq + Ord + Debug + Send + Sync,