Struct PreimageKey

pub struct PreimageKey { /* private fields */ }

A preimage key is a 32-byte value that identifies a preimage that may be fetched from the oracle.

Layout:

Bits	Description
[0, 1)	Type byte
[1, 32)	Data

Implementations

impl PreimageKey

pub fn new(key: [u8; 32], key_type: PreimageKeyType) -> Self

Creates a new PreimageKey from a 32-byte value and a PreimageKeyType. The 32-byte value will be truncated to 31 bytes by taking the low-order 31 bytes.

pub fn new_local(local_ident: u64) -> Self

Creates a new local PreimageKey from a 64-bit local identifier. The local identifier will be written into the low-order 8 bytes of the big-endian 31-byte data field.

pub fn new_keccak256(digest: [u8; 32]) -> Self

Creates a new keccak256 PreimageKey from a 32-byte keccak256 digest. The digest will be truncated to 31 bytes by taking the low-order 31 bytes.

pub fn new_precompile(precompile_addr: [u8; 20], input: &[u8]) -> Self

Creates a new precompile PreimageKey from a precompile address and input. The key will be constructed as keccak256(precompile_addr ++ input), and then the high-order byte of the digest will be set to the type byte.

pub const fn key_type(&self) -> PreimageKeyType

Returns the PreimageKeyType for the PreimageKey.

pub const fn key_value(&self) -> U256

Returns the value of the PreimageKey as a U256.

Trait Implementations

impl Clone for PreimageKey

fn clone(&self) -> PreimageKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PreimageKey

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

Formats the value using the given formatter.

impl Default for PreimageKey

fn default() -> PreimageKey

Returns the “default value” for a type.

impl Display for PreimageKey

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

Formats the value using the given formatter.

impl From<PreimageKey> for [u8; 32]

fn from(key: PreimageKey) -> Self

Converts to this type from the input type.

impl From<PreimageKey> for B256

fn from(value: PreimageKey) -> Self

Converts to this type from the input type.

impl Hash for PreimageKey

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 PreimageKey

fn cmp(&self, other: &PreimageKey) -> 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 PreimageKey

fn eq(&self, other: &PreimageKey) -> 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 PreimageKey

fn partial_cmp(&self, other: &PreimageKey) -> 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 TryFrom<[u8; 32]> for PreimageKey

type Error = PreimageOracleError

The type returned in the event of a conversion error.

fn try_from(value: [u8; 32]) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PreimageKey

impl Eq for PreimageKey

impl StructuralPartialEq for PreimageKey