Enum Key

#[repr(C)]
pub enum Key {
    Account(AccountHash),
    Hash(HashAddr),
    URef(URef),
    Transfer(TransferAddr),
    DeployInfo(DeployHash),
    EraInfo(EraId),
    Balance(URefAddr),
    Bid(AccountHash),
    Withdraw(AccountHash),
    Dictionary(DictionaryAddr),
    SystemEntityRegistry,
    EraSummary,
    Unbond(AccountHash),
    ChainspecRegistry,
    ChecksumRegistry,
    BidAddr(BidAddr),
    SmartContract(PackageAddr),
    AddressableEntity(EntityAddr),
    ByteCode(ByteCodeAddr),
    Message(MessageAddr),
    NamedKey(NamedKeyAddr),
    BlockGlobal(BlockGlobalAddr),
    BalanceHold(BalanceHoldAddr),
    EntryPoint(EntryPointAddr),
    State(EntityAddr),
}

The key under which data (e.g. CLValues, smart contracts, user accounts) are stored in global state.

Variants

Account(AccountHash)

A Key under which a user account is stored.

Hash(HashAddr)

A Key under which a smart contract is stored and which is the pseudo-hash of the contract.

URef(URef)

A Key which is a URef, under which most types of data can be stored.

Transfer(TransferAddr)

A Key under which a transfer is stored.

DeployInfo(DeployHash)

A Key under which a deploy info is stored.

EraInfo(EraId)

A Key under which an era info is stored.

Balance(URefAddr)

A Key under which a purse balance is stored.

Bid(AccountHash)

A Key under which bid information is stored.

Withdraw(AccountHash)

A Key under which withdraw information is stored.

Dictionary(DictionaryAddr)

A Key whose value is derived by hashing a URef address and arbitrary data, under which a dictionary is stored.

SystemEntityRegistry

A Key under which system entity hashes are stored.

EraSummary

A Key under which current era info is stored.

Unbond(AccountHash)

A Key under which unbond information is stored.

ChainspecRegistry

A Key under which chainspec and other hashes are stored.

ChecksumRegistry

A Key under which a registry of checksums is stored.

BidAddr(BidAddr)

A Key under which bid information is stored.

SmartContract(PackageAddr)

A Key under which package information is stored.

AddressableEntity(EntityAddr)

A Key under which an addressable entity is stored.

ByteCode(ByteCodeAddr)

A Key under which a byte code record is stored.

Message(MessageAddr)

A Key under which a message is stored.

NamedKey(NamedKeyAddr)

A Key under which a single named key entry is stored.

BlockGlobal(BlockGlobalAddr)

A Key under which per-block details are stored to global state.

BalanceHold(BalanceHoldAddr)

A Key under which a hold on a purse balance is stored.

EntryPoint(EntryPointAddr)

A Key under which a entrypoint record is written.

State(EntityAddr)

A Key under which a contract’s state lives.

Implementations

impl Key

pub const fn max_serialized_length() -> usize

Returns the maximum size a Key can be serialized into.

pub fn normalize(self) -> Key

If self is of type Key::URef, returns self with the AccessRights stripped from the wrapped URef, otherwise returns self unmodified.

pub fn to_formatted_string(self) -> String

Returns a human-readable version of self, with the inner bytes encoded to Base16.

pub fn from_formatted_str(input: &str) -> Result<Key, FromStrError>

Parses a string formatted as per Self::to_formatted_string() into a Key.

pub fn into_account(self) -> Option<AccountHash>

Returns the inner bytes of self if self is of type Key::Account, otherwise returns None.

pub fn into_hash_addr(self) -> Option<HashAddr>

Returns the inner bytes of self if self is of type Key::Hash, otherwise returns None.

pub fn into_entity_hash_addr(self) -> Option<HashAddr>

Returns the inner bytes of self if self is of type Key::AddressableEntity, otherwise returns None.

pub fn into_package_addr(self) -> Option<PackageAddr>

Returns the inner bytes of self if self is of type Key::SmartContract, otherwise returns None.

pub fn into_entity_hash(self) -> Option<AddressableEntityHash>

Returns AddressableEntityHash of self if self is of type Key::AddressableEntity, otherwise returns None.

pub fn into_package_hash(self) -> Option<PackageHash>

Returns PackageHash of self if self is of type Key::SmartContract, otherwise returns None.

pub fn into_named_key_addr(self) -> Option<NamedKeyAddr>

Returns NamedKeyAddr of self if self is of type Key::NamedKey, otherwise returns None.

pub fn into_uref(self) -> Option<URef>

Returns the inner URef if self is of type Key::URef, otherwise returns None.

pub fn as_uref(&self) -> Option<&URef>

Returns a reference to the inner URef if self is of type Key::URef, otherwise returns None.

pub fn as_uref_mut(&mut self) -> Option<&mut URef>

Returns a reference to the inner URef if self is of type Key::URef, otherwise returns None.

pub fn as_balance(&self) -> Option<&URefAddr>

Returns a reference to the inner URefAddr if self is of type Key::Balance, otherwise returns None.

pub fn as_balance_hold(&self) -> Option<&BalanceHoldAddr>

Returns a reference to the inner BalanceHoldAddr if self is of type Key::BalanceHold, otherwise returns None.

pub fn as_dictionary(&self) -> Option<&DictionaryAddr>

Returns a reference to the inner DictionaryAddr if self is of type Key::Dictionary, otherwise returns None.

pub fn as_bid_addr(&self) -> Option<&BidAddr>

Returns a reference to the inner BidAddr if self is of type Key::Bid, otherwise returns None.

pub fn as_message_topic_name_hash(&self) -> Option<TopicNameHash>

Returns a reference to the inner TopicNameHash if self is of the type Key::Message otherwise returns None.

pub fn uref_to_hash(&self) -> Option<Key>

Casts a Key::URef to a Key::Hash

pub fn withdraw_to_unbond(&self) -> Option<Key>

Casts a Key::Withdraw to a Key::Unbond

pub fn dictionary(seed_uref: URef, dictionary_item_key: &[u8]) -> Key

Creates a new Key::Dictionary variant based on a seed_uref and a dictionary_item_key bytes.

pub fn addressable_entity_key( entity_kind_tag: EntityKindTag, entity_hash: AddressableEntityHash, ) -> Self

Creates a new Key::AddressableEntity variant from a package kind and an entity hash.

pub fn contract_entity_key(entity_hash: AddressableEntityHash) -> Key

Creates a new Key::AddressableEntity for a Smart contract.

pub fn byte_code_key(byte_code_addr: ByteCodeAddr) -> Self

Creates a new Key::ByteCode variant from a byte code kind and an byte code addr.

pub fn message( entity_addr: EntityAddr, topic_name_hash: TopicNameHash, index: u32, ) -> Key

Creates a new Key::Message variant that identifies an indexed message based on an hash_addr, topic_name_hash and message index.

pub fn message_topic( entity_addr: EntityAddr, topic_name_hash: TopicNameHash, ) -> Key

Creates a new Key::Message variant that identifies a message topic based on an hash_addr and a hash of the topic name.

pub fn entry_point(entry_point_addr: EntryPointAddr) -> Self

Creates a new Key::EntryPoint variant from an entrypoint addr.

pub fn is_dictionary_key(&self) -> bool

Returns true if the key is of type Key::Dictionary.

pub fn is_balance_key(&self) -> bool

Returns true if the key is of type Key::Bid.

pub fn is_bid_addr_key(&self) -> bool

Returns true if the key is of type Key::BidAddr.

pub fn is_named_key(&self) -> bool

Returns true if the key is of type Key::NamedKey.

pub fn is_system_key(&self) -> bool

Returns if the inner address is for a system contract entity.

pub fn is_smart_contract_key(&self) -> bool

Return true if the inner Key is of the smart contract type.

pub fn is_named_key_entry(&self) -> bool

Returns true if the key is of type Key::NamedKey and its Entry variant.

pub fn is_entry_for_base(&self, entity_addr: &EntityAddr) -> bool

Returns true if the key is of type Key::NamedKey and the variants have the same EntityAddr.

pub fn is_readable(&self, entity_addr: &EntityAddr) -> bool

Is the record under this key readable by the entity corresponding to the imputed address?

pub fn is_addable(&self, entity_addr: &EntityAddr) -> bool

Is the record under this key addable by the entity corresponding to the imputed address?

pub fn is_writeable(&self, entity_addr: &EntityAddr) -> bool

Is the record under this key writeable by the entity corresponding to the imputed address?

pub fn into_entity_addr(self) -> Option<EntityAddr>

Returns an entity addr for a Key::AddressableEntity.

Trait Implementations

impl CLTyped for Key

fn cl_type() -> CLType

The CLType of Self.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

Performs copy-assignment from source.

impl DataSize for Key

where AccountHash: DataSize, HashAddr: DataSize, URef: DataSize, TransferAddr: DataSize, DeployHash: DataSize, EraId: DataSize, URefAddr: DataSize, DictionaryAddr: DataSize, BidAddr: DataSize, PackageAddr: DataSize, EntityAddr: DataSize, ByteCodeAddr: DataSize, MessageAddr: DataSize, NamedKeyAddr: DataSize, BlockGlobalAddr: DataSize, BalanceHoldAddr: DataSize, EntryPointAddr: DataSize,

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Key

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Key

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl Distribution<Key> for Standard

Available on crate feature testing only.

fn sample<R: Rng + ?Sized>(&self, rng: &mut R) -> Key

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl From<AccountHash> for Key

fn from(account_hash: AccountHash) -> Key

Converts to this type from the input type.

impl From<BalanceHoldAddr> for Key

fn from(balance_hold_addr: BalanceHoldAddr) -> Self

Converts to this type from the input type.

impl From<BidAddr> for Key

fn from(bid_addr: BidAddr) -> Self

Converts to this type from the input type.

impl From<BlockGlobalAddr> for Key

fn from(block_global_addr: BlockGlobalAddr) -> Self

Converts to this type from the input type.

impl From<ByteCodeAddr> for Key

fn from(value: ByteCodeAddr) -> Self

Converts to this type from the input type.

impl From<ContractHash> for Key

fn from(contract_hash: ContractHash) -> Self

Converts to this type from the input type.

impl From<ContractPackageHash> for Key

fn from(contract_package_hash: ContractPackageHash) -> Self

Converts to this type from the input type.

impl From<ContractWasmHash> for Key

fn from(wasm_hash: ContractWasmHash) -> Self

Converts to this type from the input type.

impl From<EntityAddr> for Key

fn from(entity_addr: EntityAddr) -> Self

Converts to this type from the input type.

impl From<NamedKeyAddr> for Key

fn from(value: NamedKeyAddr) -> Self

Converts to this type from the input type.

impl From<PackageHash> for Key

fn from(package_hash: PackageHash) -> Key

Converts to this type from the input type.

impl From<URef> for Key

fn from(uref: URef) -> Key

Converts to this type from the input type.

impl FromBytes for Key

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

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl Hash for Key

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 JsonSchema for Key

Available on crate feature json-schema only.

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Key

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

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

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

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl Tagged<KeyTag> for Key

fn tag(&self) -> KeyTag

Returns the tag of a given object

impl Tagged<u8> for Key

fn tag(&self) -> u8

Returns the tag of a given object

impl ToBytes for Key

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl TryFrom<Key> for AddressableEntityHash

type Error = ApiError

The type returned in the event of a conversion error.

fn try_from(value: Key) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Key> for BalanceHoldAddr

Available on crate feature std only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Key) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Key> for BlockGlobalAddr

Available on crate feature std only.

type Error = ()

The type returned in the event of a conversion error.

fn try_from(value: Key) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Key> for URef

type Error = ApiError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Key

impl Eq for Key

impl StructuralPartialEq for Key