Struct soroban_env_host::storage::Footprint

source · [−]

pub struct Footprint(pub OrdMap<LedgerKey, AccessType>);

Expand description

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: OrdMap<LedgerKey, AccessType>

Implementations

source

impl Footprint

source

pub fn record_access(&mut self, key: &LedgerKey, ty: AccessType)

source

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

Trait Implementations

source

impl Clone for Footprint

source

fn clone(&self) -> Footprint

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Default for Footprint

source

fn default() -> Footprint

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl RefUnwindSafe for Footprint

impl !Send for Footprint

impl !Sync for Footprint

impl Unpin for Footprint

impl UnwindSafe for Footprint

Blanket Implementations

source

impl<T> Any for T where
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<E, F, T> TryIntoVal<E, T> for F where
E: Env,
F: TryInto<T>,

type Error = <F as TryInto<T>>::Error

source

fn try_into_val(self, &E) -> Result<T, <F as TryIntoVal<E, T>>::Error>

source

Struct soroban_env_host::storage::Footprint

Tuple Fields

Implementations

impl Footprint

pub fn record_access(&mut self, key: &LedgerKey, ty: AccessType)

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

Trait Implementations

impl Clone for Footprint

fn clone(&self) -> Footprint

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

impl Default for Footprint

fn default() -> Footprint

Auto Trait Implementations

impl RefUnwindSafe for Footprint

impl !Send for Footprint

impl !Sync for Footprint

impl Unpin for Footprint

impl UnwindSafe for Footprint

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for T where T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<E, F, T> IntoVal<E, T> for F where E: Env, F: Into<T>,

fn into_val(self, &E) -> T

fn into_env_val(self, env: &E) -> EnvVal<E, V>

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<E, F, T> TryIntoVal<E, T> for F where E: Env, F: TryInto<T>,

type Error = <F as TryInto<T>>::Error

fn try_into_val(self, &E) -> Result<T, <F as TryIntoVal<E, T>>::Error>

fn try_into_env_val(self, env: &E) -> Result<EnvVal<E, V>, Self::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T> Downcast for T where
T: Any,

impl<T, U> Into<U> for T where
U: From<T>,

impl<E, F, T> IntoVal<E, T> for F where
E: Env,
F: Into<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<E, F, T> TryIntoVal<E, T> for F where
E: Env,
F: TryInto<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,