Enum casperlabs_types::Key

#[repr(C)]pub enum Key {
    Account(PublicKey),
    Hash([u8; 32]),
    URef(URef),
    Local {
        seed: [u8; 32],
        hash: [u8; 32],
    },
}

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

Variants

Account(PublicKey)

A Key under which a user account is stored.

Hash([u8; 32])

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.

Local

A Key to data (normally a CLValue) which is held in local-storage rather than global-storage.

Fields of Local

seed: [u8; 32]

A value derived from the base key defining the local context.

hash: [u8; 32]

A hash identifying the stored data.

Methods

impl Key

pub fn local(seed: [u8; 32], key_bytes: &[u8]) -> Self

Constructs a new Key::Local by hashing seed concatenated with key_bytes.

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 as_string(&self) -> String

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

pub fn to_contract_ref(self) -> Option<ContractRef>

Consumes and converts self to a ContractRef if self is of type Key::Hash or Key::URef, otherwise returns None.

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

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

pub fn into_hash(self) -> Option<[u8; 32]>

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

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

pub fn into_local(self) -> Option<[u8; 64]>

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

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

impl Debug for Key

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

Formats the value using the given formatter.

impl Display for Key

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

Formats the value using the given formatter.

impl Eq for Key

impl From<ContractRef> for Key

fn from(contract_ref: ContractRef) -> Self

Performs the conversion.

impl From<URef> for Key

fn from(uref: URef) -> Key

Performs the conversion.

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, 

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.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Key> for Key

fn eq(&self, other: &Key) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Key) -> bool

This method tests for !=.

impl PartialOrd<Key> 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: &Key) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Key) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Key) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Key) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Key

impl StructuralPartialEq for Key

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