Struct frame_benchmarking::TrackedStorageKey

pub struct TrackedStorageKey {
    pub key: Vec<u8, Global>,
    pub reads: u32,
    pub writes: u32,
    pub whitelisted: bool,
}

Storage key with read/write tracking information.

Fields

key: Vec<u8, Global>

reads: u32

writes: u32

whitelisted: bool

Implementations

impl TrackedStorageKey

pub fn new(key: Vec<u8, Global>) -> TrackedStorageKey

Create a default TrackedStorageKey

pub fn has_been_read(&self) -> bool

Check if this key has been “read”, i.e. it exists in the memory overlay.

Can be true if the key has been read, has been written to, or has been whitelisted.

pub fn has_been_written(&self) -> bool

Check if this key has been “written”, i.e. a new value will be committed to the database.

Can be true if the key has been written to, or has been whitelisted.

pub fn add_read(&mut self)

Add a storage read to this key.

pub fn add_write(&mut self)

Add a storage write to this key.

pub fn whitelist(&mut self)

Whitelist this key.

Trait Implementations

impl Clone for TrackedStorageKey

fn clone(&self) -> TrackedStorageKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackedStorageKey

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

Formats the value using the given formatter.

impl Decode for TrackedStorageKey

fn decode<__CodecInputEdqy>(
    __codec_input_edqy: &mut __CodecInputEdqy
) -> Result<TrackedStorageKey, Error>where
    __CodecInputEdqy: Input,

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Encode for TrackedStorageKey

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

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

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.

impl From<Vec<u8, Global>> for TrackedStorageKey

fn from(key: Vec<u8, Global>) -> TrackedStorageKey

Converts to this type from the input type.

impl Hash for TrackedStorageKey

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 TrackedStorageKey

fn cmp(&self, other: &TrackedStorageKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<TrackedStorageKey> for TrackedStorageKey

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

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

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<TrackedStorageKey> for TrackedStorageKey

fn partial_cmp(&self, other: &TrackedStorageKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

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

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

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

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

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

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 PassBy for TrackedStorageKey

type PassBy = Codec<TrackedStorageKey>

The strategy that should be used to pass the type.

impl EncodeLike<TrackedStorageKey> for TrackedStorageKey

impl Eq for TrackedStorageKey

impl StructuralEq for TrackedStorageKey

impl StructuralPartialEq for TrackedStorageKey