Enum StorageKey 

pub enum StorageKey {
    Account(Account),
    Int(i64),
    Principal(Principal),
    Subaccount(Subaccount),
    Timestamp(Timestamp),
    Uint(u64),
    Ulid(Ulid),
    Unit,
}

StorageKey

Storage-normalized scalar key used by persistence and indexing.

This type defines the only on-disk representation for scalar keys. It is deliberately separated from typed identity (Ref<E>).

Variants

Account(Account)

Int(i64)

Principal(Principal)

Subaccount(Subaccount)

Timestamp(Timestamp)

Uint(u64)

Ulid(Ulid)

Unit

Implementations

impl StorageKey

pub const STORED_SIZE_BYTES: u64 = 64

Fixed serialized size in bytes (protocol invariant). DO NOT CHANGE without migration.

pub const STORED_SIZE_USIZE: usize

pub const MIN: Self

Global minimum key for scan bounds.

pub const fn try_from_value( value: &Value, ) -> Result<Self, StorageKeyEncodeError>

pub fn max_storable() -> Self

Sentinel key representing the maximum storable value.

pub const fn lower_bound() -> Self

pub const fn upper_bound() -> Self

pub fn to_bytes(&self) -> Result<[u8; 64], StorageKeyEncodeError>

Encode this key into its fixed-size on-disk representation.

pub fn try_from_bytes(bytes: &[u8]) -> Result<Self, &'static str>

pub const fn as_value(&self) -> Value

Convert this storage-normalized key into a semantic Value.

Intended ONLY for diagnostics, explain output, planner invariants, and fingerprinting. Must not be used for query semantics.

Trait Implementations

impl CandidType for StorageKey

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 StorageKey

fn clone(&self) -> StorageKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StorageKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StorageKey

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StorageKey

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

Formats the value using the given formatter.

impl Hash for StorageKey

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 StorageKey

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

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

fn partial_cmp(&self, other: &Self) -> 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 StorageKey

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for StorageKey

type Error = &'static str

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for StorageKey

impl Eq for StorageKey

impl StructuralPartialEq for StorageKey