Struct LedgerSnapshot

pub struct LedgerSnapshot {
    pub protocol_version: u32,
    pub sequence_number: u32,
    pub timestamp: u64,
    pub network_id: [u8; 32],
    pub base_reserve: u32,
    pub min_persistent_entry_ttl: u32,
    pub min_temp_entry_ttl: u32,
    pub max_entry_ttl: u32,
    pub ledger_entries: Vec<(Box<LedgerKey>, (Box<LedgerEntry>, Option<u32>))>,
}

Ledger snapshot stores a snapshot of a ledger that can be restored for use in environments as a LedgerInfo and a SnapshotSource.

Fields

protocol_version: u32

sequence_number: u32

timestamp: u64

network_id: [u8; 32]

base_reserve: u32

min_persistent_entry_ttl: u32

min_temp_entry_ttl: u32

max_entry_ttl: u32

ledger_entries: Vec<(Box<LedgerKey>, (Box<LedgerEntry>, Option<u32>))>

Implementations

impl LedgerSnapshot

pub fn from<'a>( info: LedgerInfo, entries: impl IntoIterator<Item = (&'a Box<LedgerKey>, (&'a Box<LedgerEntry>, Option<u32>))>, ) -> Self

pub fn update(&mut self, host: &Host)

Update the snapshot with the state within the given Host.

The ledger info of the host will overwrite the ledger info in the snapshot. The entries in the host’s storage will overwrite entries in the snapshot. Existing entries in the snapshot that are untouched by the host will remain.

pub fn ledger_info(&self) -> LedgerInfo

pub fn set_ledger_info(&mut self, info: LedgerInfo)

Set the ledger info in the snapshot.

pub fn entries( &self, ) -> impl IntoIterator<Item = (&Box<LedgerKey>, &(Box<LedgerEntry>, Option<u32>))>

Get the entries in the snapshot.

pub fn set_entries<'a>( &mut self, entries: impl IntoIterator<Item = (&'a Box<LedgerKey>, (&'a Box<LedgerEntry>, Option<u32>))>, )

Replace the entries in the snapshot with the entries in the iterator.

pub fn update_entries<'a>( &mut self, entries: impl IntoIterator<Item = &'a (Rc<LedgerKey>, Option<(Rc<LedgerEntry>, Option<u32>)>)>, )

Update entries in the snapshot by adding or replacing any entries that have entry in the input iterator, or removing any that does not have an entry.

impl LedgerSnapshot

pub fn read(r: impl Read) -> Result<LedgerSnapshot, Error>

pub fn read_file(p: impl AsRef<Path>) -> Result<LedgerSnapshot, Error>

pub fn write(&self, w: impl Write) -> Result<(), Error>

pub fn write_file(&self, p: impl AsRef<Path>) -> Result<(), Error>

Trait Implementations

impl Clone for LedgerSnapshot

fn clone(&self) -> LedgerSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerSnapshot

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

Formats the value using the given formatter.

impl Default for LedgerSnapshot

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LedgerSnapshot

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for LedgerSnapshot

fn eq(&self, other: &LedgerSnapshot) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LedgerSnapshot

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SnapshotSource for &LedgerSnapshot

fn get( &self, key: &Rc<LedgerKey>, ) -> Result<Option<(Rc<LedgerEntry>, Option<u32>)>, HostError>

Returns the ledger entry for the key and its live_until ledger if entry exists, or None otherwise.

impl SnapshotSource for LedgerSnapshot

fn get( &self, key: &Rc<LedgerKey>, ) -> Result<Option<(Rc<LedgerEntry>, Option<u32>)>, HostError>

Returns the ledger entry for the key and its live_until ledger if entry exists, or None otherwise.

impl Eq for LedgerSnapshot

impl StructuralPartialEq for LedgerSnapshot