Struct soroban_env_guest::xdr::StateArchivalSettings

pub struct StateArchivalSettings {
    pub max_entry_ttl: u32,
    pub min_temporary_ttl: u32,
    pub min_persistent_ttl: u32,
    pub persistent_rent_rate_denominator: i64,
    pub temp_rent_rate_denominator: i64,
    pub max_entries_to_archive: u32,
    pub bucket_list_size_window_sample_size: u32,
    pub bucket_list_window_sample_period: u32,
    pub eviction_scan_size: u32,
    pub starting_eviction_scan_level: u32,
}

StateArchivalSettings is an XDR Struct defines as:

struct StateArchivalSettings {
    uint32 maxEntryTTL;
    uint32 minTemporaryTTL;
    uint32 minPersistentTTL;

    // rent_fee = wfee_rate_average / rent_rate_denominator_for_type
    int64 persistentRentRateDenominator;
    int64 tempRentRateDenominator;

    // max number of entries that emit archival meta in a single ledger
    uint32 maxEntriesToArchive;

    // Number of snapshots to use when calculating average BucketList size
    uint32 bucketListSizeWindowSampleSize;

    // How often to sample the BucketList size for the average, in ledgers
    uint32 bucketListWindowSamplePeriod;

    // Maximum number of bytes that we scan for eviction per ledger
    uint32 evictionScanSize;

    // Lowest BucketList level to be scanned to evict entries
    uint32 startingEvictionScanLevel;
};

Fields

max_entry_ttl: u32

min_temporary_ttl: u32

min_persistent_ttl: u32

persistent_rent_rate_denominator: i64

temp_rent_rate_denominator: i64

max_entries_to_archive: u32

bucket_list_size_window_sample_size: u32

bucket_list_window_sample_period: u32

eviction_scan_size: u32

starting_eviction_scan_level: u32

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for StateArchivalSettings

fn arbitrary( u: &mut Unstructured<'arbitrary> ) -> Result<StateArchivalSettings, Error>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest( u: Unstructured<'arbitrary> ) -> Result<StateArchivalSettings, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for StateArchivalSettings

fn clone(&self) -> StateArchivalSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StateArchivalSettings

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

Formats the value using the given formatter.

impl Hash for StateArchivalSettings

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 StateArchivalSettings

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

Restrict a value to a certain interval.

impl PartialEq for StateArchivalSettings

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

fn partial_cmp(&self, other: &StateArchivalSettings) -> 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 ReadXdr for StateArchivalSettings

fn read_xdr<R>(r: &mut Limited<R>) -> Result<StateArchivalSettings, Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_to_end<R>(r: &mut Limited<R>) -> Result<Self, Error>

where R: Read,

Read the XDR and construct the type, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_into<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR and construct the type.

fn read_xdr_into_to_end<R>(&mut self, r: &mut Limited<R>) -> Result<(), Error>

where R: Read,

Read the XDR into the existing value, and consider it an error if the read does not completely consume the read implementation.

fn read_xdr_iter<R>(r: &mut Limited<R>) -> ReadXdrIter<&mut R, Self>

where R: Read,

Create an iterator that reads the read implementation as a stream of values that are read into the implementing type.

fn from_xdr(bytes: impl AsRef<[u8]>, limits: Limits) -> Result<Self, Error>

Construct the type from the XDR bytes.

impl WriteXdr for StateArchivalSettings

fn write_xdr<W>(&self, w: &mut Limited<W>) -> Result<(), Error>

where W: Write,

fn to_xdr(&self, limits: Limits) -> Result<Vec<u8>, Error>

impl Eq for StateArchivalSettings

impl StructuralPartialEq for StateArchivalSettings