Struct ink_primitives::Key

#[repr(transparent)]
pub struct Key(_);

A key into the smart contract storage.

Note

• The storage of an ink! smart contract can be viewed as a key-value store.
• In order to manipulate its storage an ink! smart contract is required to indicate the respective cells using this primitive type.
• The Key type can be compared to a raw pointer and also allows operations similar to pointer arithmetic.
• Users usually should not have to deal with this low-level primitive themselves and instead use the more high-level primitives provided by the ink_storage crate.

Implementations

impl Key

pub const fn new(bytes: [u8; 32]) -> Self

Creates a new key instance from the given bytes.

Note

This constructor only exists since it is not yet possible to define the From trait implementation as const.

impl Key

pub fn add_assign_using<T>(&self, rhs: T, result: &mut Key)where
    T: Into<u64>,

Adds the u64 value to the key storing the result in result.

Note

This will overwrite the contents of the result key.

Trait Implementations

impl AddAssign<&u64> for Key

fn add_assign(&mut self, rhs: &u64)

Performs the += operation.

impl AddAssign<u64> for Key

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl AsMut<[u8; 32]> for Key

fn as_mut(&mut self) -> &mut [u8; 32]

Converts this type into a mutable reference of the (usually inferred) input type.

impl AsRef<[u8; 32]> for Key

fn as_ref(&self) -> &[u8; 32]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

const 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 Decode for Key

fn decode<I>(input: &mut I) -> Result<Self, Error>where
    I: Input,

Attempt to deserialise the value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

fn skip<I>(input: &mut I) -> Result<(), Error>where
    I: Input,

Attempt to skip the encoded value from input.

impl Default for Key

fn default() -> Key

Returns the “default value” for a type.

impl Display for Key

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

Formats the value using the given formatter.

impl Encode for Key

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<O>(&self, output: &mut O)where
    O: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

impl From<[u8; 32]> for Key

fn from(bytes: [u8; 32]) -> Self

Converts to this type from the input type.

impl From<Key> for KeyPtr

fn from(key: Key) -> Self

Converts to this type from the input type.

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.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

const fn lt(&self, other: &Rhs) -> bool

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

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

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

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

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

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

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

impl TypeInfo for Key

type Identity = Key

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Copy for Key

impl EncodeLike<[u8; 32]> for Key

impl Eq for Key

impl StructuralEq for Key

impl StructuralPartialEq for Key