Struct DataKey 

pub struct DataKey { /* private fields */ }

DataKey

Implementations

impl DataKey

pub const STORABLE_MAX_SIZE: u32 = 160u32

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

Build a data key for the given entity type and primary key.

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

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

pub const fn key(&self) -> Key

Return the primary key component of this data key.

pub const fn entity_id(&self) -> u64

Entity identifier (stable, compile-time constant per entity type).

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

Compute the on-disk size used by a single data entry from its value length. Includes the bounded DataKey size and the value bytes.

pub fn max_storable() -> Self

Max sentinel key for sizing.

Trait Implementations

impl CandidType for DataKey

fn _ty() -> Type

fn id() -> TypeId

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

where __S: Serializer,

fn ty() -> Type

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<'de> Deserialize<'de> for DataKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

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 Serialize for DataKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Storable for DataKey

const BOUND: Bound

The size bounds of the type.

fn to_bytes(&self) -> Cow<'_, [u8]>

Converts the element into a possibly borrowed byte slice.

fn into_bytes(self) -> Vec<u8>

Converts the element into an owned byte vector.

fn from_bytes(bytes: Cow<'_, [u8]>) -> Self

Converts bytes into an element.

fn to_bytes_checked(&self) -> Cow<'_, [u8]>

Like to_bytes, but checks that bytes conform to declared bounds.

fn into_bytes_checked(self) -> Vec<u8>

where Self: Sized,

Like into_bytes, but checks that bytes conform to declared bounds.

fn check_bounds(bytes: &[u8])

Validates that a byte slice fits within this type’s declared bounds.

impl Eq for DataKey

impl StructuralPartialEq for DataKey