Struct AllocationSlotDescriptor 

pub struct AllocationSlotDescriptor { /* private fields */ }

AllocationSlotDescriptor

Encoded allocation slot persisted in the ledger.

Constructors for built-in substrates validate their invariants before a descriptor can be used publicly. For MemoryManager slots, use AllocationSlotDescriptor::memory_manager so ID 255 is rejected.

Implementations

impl AllocationSlotDescriptor

pub const fn slot(&self) -> &AllocationSlot

Return the durable allocation slot value.

pub fn substrate(&self) -> &str

Return the substrate identifier that interprets this slot.

pub const fn descriptor_version(&self) -> u32

Return the descriptor encoding version.

impl AllocationSlotDescriptor

pub fn memory_manager(id: u8) -> Result<Self, MemoryManagerSlotError>

Construct a descriptor for a usable MemoryManager virtual memory ID.

ID 255 is the ic-stable-structures unallocated-bucket sentinel and is rejected.

pub fn memory_manager_checked(id: u8) -> Result<Self, MemoryManagerSlotError>

Construct a descriptor for a usable MemoryManager virtual memory ID.

This is an explicit alias for AllocationSlotDescriptor::memory_manager.

pub fn memory_manager_id(&self) -> Result<u8, MemoryManagerSlotError>

Return the usable MemoryManager virtual memory ID represented by this descriptor.

This validates substrate, descriptor version, slot kind, and sentinel ID rules before returning the numeric ID.

Trait Implementations

impl Clone for AllocationSlotDescriptor

fn clone(&self) -> AllocationSlotDescriptor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AllocationSlotDescriptor

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AllocationSlotDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for AllocationSlotDescriptor

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 AllocationSlotDescriptor

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

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

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AllocationSlotDescriptor

impl StructuralPartialEq for AllocationSlotDescriptor