Struct sp_state_machine::backend::IterArgs

#[non_exhaustive]
pub struct IterArgs<'a> {
    pub prefix: Option<&'a [u8]>,
    pub start_at: Option<&'a [u8]>,
    pub start_at_exclusive: bool,
    pub child_info: Option<ChildInfo>,
    pub stop_on_incomplete_database: bool,
}

A struct containing arguments for iterating over the storage.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

prefix: Option<&'a [u8]>

The prefix of the keys over which to iterate.

start_at: Option<&'a [u8]>

The prefix from which to start the iteration from.

This is inclusive and the iteration will include the key which is specified here.

start_at_exclusive: bool

If this is true then the iteration will not include the key specified in start_at, if there is such a key.

child_info: Option<ChildInfo>

The info of the child trie over which to iterate over.

stop_on_incomplete_database: bool

Whether to stop iteration when a missing trie node is reached.

When a missing trie node is reached the iterator will:

• return an error if this is set to false (default)
• return None if this is set to true

Trait Implementations

impl<'a> Default for IterArgs<'a>

fn default() -> IterArgs<'a>

Returns the “default value” for a type.