Struct SnapshotSourceInput 

pub struct SnapshotSourceInput {
    pub source: Rc<dyn SnapshotSource>,
    pub ledger_info: Option<LedgerInfo>,
    pub snapshot: Option<Rc<LedgerSnapshot>>,
}

Available on crate feature testutils only.

Input for creating an Env from a custom snapshot source.

This struct enables Env::from_ledger_snapshot to accept custom snapshot source types beyond LedgerSnapshot, providing flexibility for testing scenarios that load ledger state from different sources such as RPC endpoints, history archives, or in-memory data structures.

Fields

• source - A snapshot source implementing the SnapshotSource trait. This is used to load ledger entries on demand during test execution.

• ledger_info - Optional ledger info to initialize the environment with. If None, default test ledger info is used.

• snapshot - Optional LedgerSnapshot used as the base for capturing state changes. When the test completes, modified entries are written to this snapshot. If None, a new empty snapshot is created.

Example

use soroban_sdk::testutils::{SnapshotSource, SnapshotSourceInput, HostError};
use soroban_sdk::xdr::{LedgerEntry, LedgerKey};
use soroban_sdk::Env;
use std::rc::Rc;

struct MyCustomSource;

impl SnapshotSource for MyCustomSource {
    fn get(
        &self,
        key: &Rc<LedgerKey>,
    ) -> Result<Option<(Rc<LedgerEntry>, Option<u32>)>, HostError> {
        // Return None for keys not found, or Some((entry, live_until_ledger))
        Ok(None)
    }
}

let input = SnapshotSourceInput {
    source: Rc::new(MyCustomSource),
    ledger_info: None,
    snapshot: None,
};
let env = Env::from_ledger_snapshot(input);

Fields

source: Rc<dyn SnapshotSource>

ledger_info: Option<LedgerInfo>

snapshot: Option<Rc<LedgerSnapshot>>

Trait Implementations

impl From<LedgerSnapshot> for SnapshotSourceInput

Converts a LedgerSnapshot into a SnapshotSourceInput.

This conversion maintains backward compatibility with the existing API, allowing LedgerSnapshot to be used directly with Env::from_ledger_snapshot.

The LedgerSnapshot is wrapped in an Rc and used for all three fields:

• As the snapshot source for loading ledger entries
• To provide the ledger info for the environment
• As the base snapshot for capturing state changes

fn from(s: LedgerSnapshot) -> Self

Converts to this type from the input type.