Enum SubstateKey

pub enum SubstateKey {
    Field(u8),
    Map(Vec<u8>),
    Sorted(([u8; 2], Vec<u8>)),
}

The unique identifier of a substate within a node module.

Variants

Field(u8)

Map(Vec<u8>)

Sorted(([u8; 2], Vec<u8>))

Implementations

impl SubstateKey

pub fn map(key: &impl ScryptoEncode) -> SubstateKey

pub fn for_field(&self) -> Option<&u8>

pub fn for_map(&self) -> Option<&Vec<u8>>

pub fn into_map(self) -> Vec<u8>

pub fn for_sorted(&self) -> Option<&([u8; 2], Vec<u8>)>

pub fn as_ref(&self) -> SubstateKeyRef<'_>

Trait Implementations

impl<X> Categorize<X> for SubstateKey

where X: CustomValueKind,

fn value_kind() -> ValueKind<X>

impl Clone for SubstateKey

fn clone(&self) -> SubstateKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubstateKey

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

Formats the value using the given formatter.

impl<D, X> Decode<X, D> for SubstateKey

where D: Decoder<X>, X: CustomValueKind,

fn decode_body_with_value_kind( decoder: &mut D, value_kind: ValueKind<X>, ) -> Result<SubstateKey, DecodeError>

Decodes the type from the decoder, which should match a preloaded value kind.

impl<C> Describe<C> for SubstateKey

where C: CustomTypeKind<RustTypeId>,

const TYPE_ID: RustTypeId

The TYPE_ID should give a unique identifier for its SBOR schema type. An SBOR schema type capture details about the SBOR payload, how it should be interpreted, validated and displayed.

fn type_data() -> TypeData<C, RustTypeId>

Returns the local schema for the given type.

fn add_all_dependencies(aggregator: &mut TypeAggregator<C>)

For each type referenced in get_local_type_data, we need to ensure that the type and all of its own references get added to the aggregator.

impl<E, X> Encode<X, E> for SubstateKey

where E: Encoder<X>, X: CustomValueKind,

fn encode_value_kind(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR value’s kind to the encoder

fn encode_body(&self, encoder: &mut E) -> Result<(), EncodeError>

Encodes the SBOR body of the type to the encoder.

impl From<AuthZoneField> for SubstateKey

fn from(value: AuthZoneField) -> Self

Converts to this type from the input type.

impl From<BootLoaderField> for SubstateKey

fn from(value: BootLoaderField) -> Self

Converts to this type from the input type.

impl From<ComponentField> for SubstateKey

fn from(value: ComponentField) -> Self

Converts to this type from the input type.

impl From<FungibleBucketField> for SubstateKey

fn from(value: FungibleBucketField) -> Self

Converts to this type from the input type.

impl From<FungibleProofField> for SubstateKey

fn from(value: FungibleProofField) -> Self

Converts to this type from the input type.

impl From<NonFungibleBucketField> for SubstateKey

fn from(value: NonFungibleBucketField) -> Self

Converts to this type from the input type.

impl From<NonFungibleProofField> for SubstateKey

fn from(value: NonFungibleProofField) -> Self

Converts to this type from the input type.

impl From<ProtocolUpdateStatusField> for SubstateKey

fn from(value: ProtocolUpdateStatusField) -> Self

Converts to this type from the input type.

impl From<RoyaltyField> for SubstateKey

fn from(value: RoyaltyField) -> Self

Converts to this type from the input type.

impl From<TransactionTrackerField> for SubstateKey

fn from(value: TransactionTrackerField) -> Self

Converts to this type from the input type.

impl From<TypeInfoField> for SubstateKey

fn from(value: TypeInfoField) -> Self

Converts to this type from the input type.

impl From<WorktopField> for SubstateKey

fn from(value: WorktopField) -> Self

Converts to this type from the input type.

impl Hash for SubstateKey

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

where __H: Hasher,

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 SubstateKey

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

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

fn partial_cmp(&self, other: &SubstateKey) -> 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<'a> ResolvableSubstateKey<'a> for &'a SubstateKey

fn into_substate_key_or_ref(self) -> SubstateKeyOrRef<'a>

fn into_substate_key(self) -> SubstateKey

impl<X> SborEnum<X> for SubstateKey

where X: CustomValueKind,

fn get_discriminator(&self) -> u8

fn get_length(&self) -> usize

impl TryFrom<&SubstateKey> for AuthZoneField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for BootLoaderField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for ComponentField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for FungibleBucketField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for FungibleProofField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for NonFungibleBucketField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for NonFungibleProofField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for ProtocolUpdateStatusField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for RoyaltyField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for TransactionTrackerField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for TypeInfoField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&SubstateKey> for WorktopField

type Error = ()

The type returned in the event of a conversion error.

fn try_from(key: &SubstateKey) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for SubstateKey

impl StructuralPartialEq for SubstateKey