Enum casper_types::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),
    SystemContractRegistry,
    EraSummary,
    Unbond(AccountHash),
    ChainspecRegistry,
    ChecksumRegistry,
}

The type under which data (e.g. CLValues, smart contracts, user accounts) are indexed on the network.

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 we store a transfer.

DeployInfo(DeployHash)

A Key under which we store a deploy info.

EraInfo(EraId)

A Key under which we store an era info.

Balance(URefAddr)

A Key under which we store a purse balance.

Bid(AccountHash)

A Key under which we store bid information

Withdraw(AccountHash)

A Key under which we store withdraw information.

Dictionary(DictionaryAddr)

A Key variant whose value is derived by hashing URefs address and arbitrary data.

SystemContractRegistry

A Key variant under which system contract hashes are stored.

EraSummary

A Key under which we store current era info.

Unbond(AccountHash)

A Key under which we store unbond information.

ChainspecRegistry

A Key variant under which chainspec and other hashes are stored.

ChecksumRegistry

A Key variant under which we store a registry of checksums.

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(self) -> Option<HashAddr>

Returns the inner bytes of self if self is of type Key::Hash, 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 into_uref(self) -> Option<URef>

Returns the inner URef if self is of type Key::URef, 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 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 is_dictionary_key(&self) -> bool

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

pub fn as_account(&self) -> Option<&AccountHash>

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

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 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

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

fn from(contract_hash: ContractHash) -> Key

Converts to this type from the input type.

impl From<ContractPackageHash> for Key

fn from(package_hash: ContractPackageHash) -> Key

Converts to this type from the input type.

impl From<ContractWasmHash> for Key

fn from(wasm_hash: ContractWasmHash) -> Key

Converts to this type from the input type.

impl From<TransferAddr> for Key

fn from(transfer_addr: TransferAddr) -> 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 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 + PartialOrd,

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 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