Struct DataKey 

pub struct DataKey { /* private fields */ }

DataKey

Implementations

impl DataKey

pub const STORED_SIZE_BYTES: u64

Fixed on-disk size in bytes (stable, protocol-level)

pub const STORED_SIZE_USIZE: usize

Fixed in-memory size (for buffers and arrays only)

pub fn new<E: EntityKind>(key: impl Into<Key>) -> Self

Construct using compile-time entity metadata.

This cannot fail in practice: ENTITY_NAME is generated and validated at compile time. If it is ever invalid, that is a programmer error.

pub fn lower_bound<E: EntityKind>() -> Self

pub fn upper_bound<E: EntityKind>() -> Self

pub const fn key(&self) -> Key

pub const fn entity_name(&self) -> &EntityName

pub const fn entry_size_bytes(value_len: u64) -> u64

Compute on-disk entry size from value length.

pub fn max_storable() -> Self

pub fn to_raw(&self) -> Result<RawDataKey, InternalError>

Encode into fixed-size on-disk representation.

pub fn try_from_raw(raw: &RawDataKey) -> Result<Self, DataKeyDecodeError>

Trait Implementations

impl Clone for DataKey

fn clone(&self) -> DataKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataKey

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

Formats the value using the given formatter.

impl Display for DataKey

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

Formats the value using the given formatter.

impl From<DataKey> for Key

fn from(key: DataKey) -> Self

Converts to this type from the input type.

impl Hash for DataKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for DataKey

fn cmp(&self, other: &DataKey) -> 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,

Restrict a value to a certain interval.

impl PartialEq for DataKey

fn eq(&self, other: &DataKey) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for DataKey

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Eq for DataKey

impl StructuralPartialEq for DataKey