Trait bonsaidb_core::key::Key

pub trait Key<'k>: KeyEncoding<'k, Self> + Clone + Debug + Send + Sync {
    fn from_ord_bytes(bytes: &'k [u8]) -> Result<Self, Self::Error>;

    fn first_value() -> Result<Self, NextValueError> { ... }
    fn next_value(&self) -> Result<Self, NextValueError> { ... }
}

A trait that enables a type to convert itself into a memcmp-compatible sequence of bytes.

Required methods

fn from_ord_bytes(bytes: &'k [u8]) -> Result<Self, Self::Error>

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

Provided methods

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.

Implementations on Foreign Types

impl<'a> Key<'a> for Duration

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for SystemTime

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'k> Key<'k> for Cow<'k, [u8]>

fn from_ord_bytes(bytes: &[u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for Vec<u8>

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, const N: usize> Key<'a> for [u8; N]

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for ArcBytes<'a>

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for CowBytes<'a>

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for Bytes

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for String

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for ()

fn from_ord_bytes(_: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for bool

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2> Key<'a> for (T1, T2) where
    T1: Key<'a>,
    T2: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3> Key<'a> for (T1, T2, T3) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3, T4> Key<'a> for (T1, T2, T3, T4) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>,
    T4: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3, T4, T5> Key<'a> for (T1, T2, T3, T4, T5) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>,
    T4: Key<'a>,
    T5: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3, T4, T5, T6> Key<'a> for (T1, T2, T3, T4, T5, T6) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>,
    T4: Key<'a>,
    T5: Key<'a>,
    T6: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3, T4, T5, T6, T7> Key<'a> for (T1, T2, T3, T4, T5, T6, T7) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>,
    T4: Key<'a>,
    T5: Key<'a>,
    T6: Key<'a>,
    T7: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a, T1, T2, T3, T4, T5, T6, T7, T8> Key<'a> for (T1, T2, T3, T4, T5, T6, T7, T8) where
    T1: Key<'a>,
    T2: Key<'a>,
    T3: Key<'a>,
    T4: Key<'a>,
    T5: Key<'a>,
    T6: Key<'a>,
    T7: Key<'a>,
    T8: Key<'a>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

impl<'a> Key<'a> for Signed

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for Unsigned

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a, T> Key<'a> for Option<T> where
    T: Key<'a>,
    Self: KeyEncoding<'a, Self, Error = <T as KeyEncoding<'a, T>>::Error>, 

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for i8

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for u8

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for i16

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for u16

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for i32

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for u32

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for i64

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for u64

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for i128

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

impl<'a> Key<'a> for u128

fn from_ord_bytes(bytes: &'a [u8]) -> Result<Self, Self::Error>

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

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

Implementors

impl<'a> Key<'a> for Timestamp

impl<'a, Resolution> Key<'a> for LimitedResolutionDuration<Resolution> where
    Resolution: TimeResolution, 

impl<'a, Resolution, Epoch> Key<'a> for LimitedResolutionTimestamp<Resolution, Epoch> where
    Resolution: TimeResolution,
    Epoch: TimeEpoch, 

impl<'a, T> Key<'a> for T where
    T: EnumKey, 

impl<'k> Key<'k> for DocumentId