Struct soroban_env_host::storage::Footprint

pub struct Footprint(pub FootprintMap);

Describes the total set of LedgerKeys that a given transaction will access, as well as the AccessType governing each key.

A Footprint must be provided in order to run a transaction that accesses any LedgerKeys in FootprintMode::Enforcing. If a transaction has an unknown Footprint it can be calculated by running a “preflight” execution in FootprintMode::Recording, against a suitably fresh SnapshotSource.

Tuple Fields

0: FootprintMap

Implementations

impl Footprint

pub fn record_access( &mut self, key: &Rc<LedgerKey>, ty: AccessType, budget: &Budget ) -> Result<(), HostError>

pub fn enforce_access( &mut self, key: &Rc<LedgerKey>, ty: AccessType, budget: &Budget ) -> Result<(), HostError>

Trait Implementations

impl Clone for Footprint

fn clone(&self) -> Footprint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Footprint

fn default() -> Footprint

Returns the “default value” for a type.

impl Hash for Footprint

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.