Struct soroban_env_host::storage::Footprint

source ·

pub struct Footprint(pub FootprintMap);

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: FootprintMap

Implementations§

source §

impl Footprint

source

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

source

pub fn enforce_access(
 &mut self,
 key: &LedgerKey,
 ty: AccessType,
 budget: &Budget
) -> 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 !UnwindSafe for Footprint

Blanket Implementations§

source §

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

source §

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source §

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

const: unstable · source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

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

const: unstable · source§

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

Mutably borrows from an owned value. Read more

source §

impl<T, C> Compare<&T> for Cwhere
C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

source §

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

source §

impl<T, U, V, E, C> Compare<(T, U, V)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E> + Compare + Compare<V>,

§

type Error = E

source §

fn compare(
 &self,
 a: &(T, U, V),
 b: &(T, U, V)
) -> Result<Ordering, <C as Compare<(T, U, V)>>::Error>

source §

impl<T, U, E, C> Compare<(T, U)> for Cwhere
C: Compare<T, Error = E, Error = E> + Compare,

§

type Error = E

source §

fn compare(
 &self,
 a: &(T, U),
 b: &(T, U)
) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

source §

impl<T, C> Compare<Box<T, Global>> for Cwhere
C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

source §

fn compare(
 &self,
 a: &Box<T, Global>,
 b: &Box<T, Global>
) -> Result<Ordering, <C as Compare<Box<T, Global>>>::Error>

source §

impl<T, C> Compare<Option<T>> for Cwhere
C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

source §

fn compare(
 &self,
 a: &Option<T>,
 b: &Option<T>
) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

source §

impl<T, C> Compare<Rc<T>> for Cwhere
C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

source §

fn compare(
 &self,
 a: &Rc<T>,
 b: &Rc<T>
) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

source §

impl<T, C> Compare<Vec<T, Global>> for Cwhere
C: Compare<T>,

§

type Error = <C as Compare<T>>::Error

source §

fn compare(
 &self,
 a: &Vec<T, Global>,
 b: &Vec<T, Global>
) -> Result<Ordering, <C as Compare<Vec<T, Global>>>::Error>

§

impl<T> Downcast for Twhere
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.

§

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.

§

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.

§

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.

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 Twhere
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 Twhere
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 Twhere
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 Twhere
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.

§

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

§

Struct soroban_env_host::storage::Footprint

Tuple Fields§

Implementations§

impl Footprint

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

pub fn enforce_access( &mut self, key: &LedgerKey, ty: AccessType, budget: &Budget) -> 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 Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T, C> Compare<&T> for Cwhere C: Compare<T>,

type Error = <C as Compare<T>>::Error

fn compare(&self, a: &&T, b: &&T) -> Result<Ordering, <C as Compare<&T>>::Error>

impl<T, U, V, E, C> Compare<(T, U, V)> for Cwhere C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

type Error = E

fn compare( &self, a: &(T, U, V), b: &(T, U, V)) -> Result<Ordering, <C as Compare<(T, U, V)>>::Error>

impl<T, U, E, C> Compare<(T, U)> for Cwhere C: Compare<T, Error = E, Error = E> + Compare<U>,

type Error = E

fn compare( &self, a: &(T, U), b: &(T, U)) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

impl<T, C> Compare<Box<T, Global>> for Cwhere C: Compare<T>,

type Error = <C as Compare<T>>::Error

fn compare( &self, a: &Box<T, Global>, b: &Box<T, Global>) -> Result<Ordering, <C as Compare<Box<T, Global>>>::Error>

impl<T, C> Compare<Option<T>> for Cwhere C: Compare<T>,

type Error = <C as Compare<T>>::Error

fn compare( &self, a: &Option<T>, b: &Option<T>) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

impl<T, C> Compare<Rc<T>> for Cwhere C: Compare<T>,

type Error = <C as Compare<T>>::Error

fn compare( &self, a: &Rc<T>, b: &Rc<T>) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

impl<T, C> Compare<Vec<T, Global>> for Cwhere C: Compare<T>,

type Error = <C as Compare<T>>::Error

fn compare( &self, a: &Vec<T, Global>, b: &Vec<T, Global>) -> Result<Ordering, <C as Compare<Vec<T, Global>>>::Error>

impl<T> Downcast for Twhere 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 Twhere U: From<T>,

fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

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

fn vzip(self) -> V

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

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

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

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

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

impl<T, C> Compare<&T> for Cwhere
C: Compare<T>,

impl<T, U, V, E, C> Compare<(T, U, V)> for Cwhere
C: Compare<T, Error = E, Error = E, Error = E> + Compare<U> + Compare<V>,

fn compare(
&self,
a: &(T, U, V),
b: &(T, U, V)
) -> Result<Ordering, <C as Compare<(T, U, V)>>::Error>

impl<T, U, E, C> Compare<(T, U)> for Cwhere
C: Compare<T, Error = E, Error = E> + Compare<U>,

fn compare(
&self,
a: &(T, U),
b: &(T, U)
) -> Result<Ordering, <C as Compare<(T, U)>>::Error>

impl<T, C> Compare<Box<T, Global>> for Cwhere
C: Compare<T>,

fn compare(
&self,
a: &Box<T, Global>,
b: &Box<T, Global>
) -> Result<Ordering, <C as Compare<Box<T, Global>>>::Error>

impl<T, C> Compare<Option<T>> for Cwhere
C: Compare<T>,

fn compare(
&self,
a: &Option<T>,
b: &Option<T>
) -> Result<Ordering, <C as Compare<Option<T>>>::Error>

impl<T, C> Compare<Rc<T>> for Cwhere
C: Compare<T>,

fn compare(
&self,
a: &Rc<T>,
b: &Rc<T>
) -> Result<Ordering, <C as Compare<Rc<T>>>::Error>

impl<T, C> Compare<Vec<T, Global>> for Cwhere
C: Compare<T>,

fn compare(
&self,
a: &Vec<T, Global>,
b: &Vec<T, Global>
) -> Result<Ordering, <C as Compare<Vec<T, Global>>>::Error>

impl<T> Downcast for Twhere
T: Any,

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

impl<T> ToOwned for Twhere
T: Clone,

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

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

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