Struct Key 

pub struct Key {
    pub segments: Vec<DbKeySeg>,
}

A storage key is made of storage key segments DbKeySeg, separated by KEY_SEGMENT_SEPARATOR.

Fields

segments: Vec<DbKeySeg>

The segments of the key in the original (left-to-right) order.

Implementations

impl Key

pub fn parse(string: impl AsRef<str>) -> Result<Key, Error>

Parses string and returns a key

pub fn push<T>(&self, other: &T) -> Result<Key, Error>

where T: KeySeg,

Returns a new key with segments of Self and the given segment

pub fn with_segment<T>(self, other: T) -> Key

where T: KeySeg,

Takes ownership of the key, appends a new segment to it, and returns the modified key.

pub fn join(&self, other: &Key) -> Key

Returns a new key with segments of Self and the given key

pub fn find_addresses(&self) -> Vec<Address>

Returns the addresses from the key segments

pub fn fst_address(&self) -> Option<&Address>

Returns the address from the first key segment if it’s an address.

pub fn iter_addresses<'k, 'this>( &'this self, ) -> impl Iterator<Item = &'this Address> + 'k

where 'this: 'k,

Iterates over all addresses in the key segments

pub fn get_at(&self, index: usize) -> Option<&DbKeySeg>

Return the segment at the index parameter

pub fn len(&self) -> usize

Returns the length

pub fn is_empty(&self) -> bool

Returns true if the key is empty

pub fn first(&self) -> Option<&DbKeySeg>

Returns the first segment of the key, or None if it is empty.

pub fn last(&self) -> Option<&DbKeySeg>

Returns the last segment of the key, or None if it is empty.

pub fn split_last(&self) -> Option<(KeyRef<'_>, &DbKeySeg)>

Returns the prefix before the last segment and last segment of the key, or None if it is empty.

pub fn wasm_code(code_hash: &Hash) -> Key

Returns a key of the wasm code of the given hash

pub fn wasm_code_name(code_name: String) -> Key

Returns a key of wasm code’s hash of the given name

pub fn wasm_code_len(code_hash: &Hash) -> Key

Returns a key of the wasm code’s length of the given hash

pub fn wasm_hash(code_path: impl AsRef<str>) -> Key

Returns a key of the wasm code hash of the given code path

pub fn validity_predicate(addr: &Address) -> Key

Returns a key of the validity predicate of the given address Only this function can push “?” segment for validity predicate

pub fn is_validity_predicate(&self) -> Option<&Address>

Check if the given key is a key to a validity predicate. If it is, returns the address of the account.

pub fn parse_db_key(db_key: &str) -> Result<Key, Error>

Returns a key from the given DB key path that has the height and the space type

pub fn sub_key(&self) -> Result<Key, Error>

Returns a sub key without the first segment

pub fn split_prefix(&self, prefix: &Key) -> Option<Option<Key>>

Check if the key begins with the given prefix and returns:

• Some(Some(suffix)) the suffix after the match with, if any, or
• Some(None) if the prefix is matched, but it has no suffix, or
• None if it doesn’t match

Trait Implementations

impl BorshDeserialize for Key

fn deserialize_reader<__R>(reader: &mut __R) -> Result<Key, Error>

where __R: Read,

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSchema for Key

fn declaration() -> String

Get the name of the type without brackets.

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

impl BorshSerialize for Key

fn serialize<__W>(&self, writer: &mut __W) -> Result<(), Error>

where __W: Write,

impl Clone for Key

fn clone(&self) -> Key

Returns a duplicate 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<(), Error>

Formats the value using the given formatter.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Key, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Key

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

Formats the value using the given formatter.

impl From<&Key> for Key

fn from(key: &Key) -> Key

Converts to this type from the input type.

impl From<&Key> for Key

fn from(mt_key: &Key) -> Key

Converts to this type from the input type.

impl From<&PendingTransfer> for Key

fn from(transfer: &PendingTransfer) -> Key

Converts to this type from the input type.

impl From<DbKeySeg> for Key

fn from(seg: DbKeySeg) -> Key

Converts to this type from the input type.

impl From<Key> for Key

fn from(key: Key) -> Key

Converts to this type from the input type.

impl FromStr for Key

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Key, Error>

Parses a string s to return a value of this type.

impl Hash for Key

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 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>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Key

impl StructuralPartialEq for Key