Struct ink_primitives::Key

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

Key into contract storage.

Used to identify contract storage cells for read and write operations. Can be compared to a raw pointer and features simple pointer arithmetic.

Note

This is the most low-level primitive to identify contract storage cells.

Unsafe

Prefer using high-level types found in ink_storage to operate on the contract storage.

Implementations

impl Key

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

Tries to return the underlying bytes as slice.

This only returns Some if the execution environment has little-endian byte order.

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

Returns the underlying bytes of the key.

This only works and is supported if the target machine has little-endian byte ordering. Use Key::try_as_bytes as a general procedure instead.

impl Key

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

Returns the bytes that are representing the key.

Trait Implementations

impl<'a> Add<&'a u64> for Key

type Output = Key

The resulting type after applying the + operator.

fn add(self, rhs: &'a u64) -> Self::Output

Performs the + operation.

impl<'a, 'b> Add<&'b u64> for &'a Key

type Output = Key

The resulting type after applying the + operator.

fn add(self, rhs: &'b u64) -> Self::Output

Performs the + operation.

impl Add<u64> for Key

type Output = Key

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl<'a> Add<u64> for &'a Key

type Output = Key

The resulting type after applying the + operator.

fn add(self, rhs: u64) -> Self::Output

Performs the + operation.

impl AddAssign<u64> for Key

fn add_assign(&mut self, rhs: u64)

Performs the += operation.

impl Clone for Key

fn clone(&self) -> Key

Returns a copy of the value.

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

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

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<T: Output + ?Sized>(&self, dest: &mut T)

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

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

Convert self to an owned vector.

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

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl Eq for Key

impl From<[u8; 32]> for Key

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

Performs the conversion.

impl From<Key> for KeyPtr

fn from(key: Key) -> Self

Performs the conversion.

impl Hash for Key

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> 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 ==.

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.

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for Key

impl StructuralPartialEq for Key

impl TypeInfo for Key

type Identity = Self

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.