Enum LedgerStateSnapshot

pub enum LedgerStateSnapshot {
    Legacy {
        path: PathBuf,
        slot_number: SlotNumber,
        filename: OsString,
    },
    InMemory {
        path: PathBuf,
        slot_number: SlotNumber,
        folder_name: OsString,
    },
}

Represent an ledger file in a Cardano node database directory

Variants

Legacy

Snapshot of a legacy ledger state (before UTxO-HD)

Fields

path: PathBuf

The path to the ledger file

slot_number: SlotNumber

The ledger file slot number

filename: OsString

The filename

InMemory

Snapshot of an UTxO-HD in-memory ledger state

Fields

path: PathBuf

The path to the ledger file

slot_number: SlotNumber

The ledger file slot number

folder_name: OsString

Name of the ledger state folder

Implementations

impl LedgerStateSnapshot

pub const IN_MEMORY_META: &'static str = "meta"

Filename of the in-memory ledger snapshot ‘meta’ file

pub const IN_MEMORY_STATE: &'static str = "state"

Filename of the in-memory ledger snapshot ‘state’ file

pub const IN_MEMORY_TABLES: &'static str = "tables"

Directory name of the in-memory ledger snapshot ‘tables’ folder

pub const IN_MEMORY_TVAR: &'static str = "tvar"

Filename of the in-memory ledger snapshot ‘tables/tvar’ file

pub fn legacy( path: PathBuf, slot_number: SlotNumber, filename: OsString, ) -> Self

LedgerStateSnapshot::Legacy factory

pub fn in_memory( path: PathBuf, slot_number: SlotNumber, folder_name: OsString, ) -> Self

LedgerStateSnapshot::InMemory factory

pub fn from_path(path: &Path) -> Option<LedgerStateSnapshot>

Convert a path to a LedgerStateSnapshot if it satisfies the constraints.

The constraints are:

• legacy state snapshot: the path must be a file, the filename should only contain a number (no extension).

pub fn list_all_in_dir( dir: &Path, ) -> Result<Vec<LedgerStateSnapshot>, LedgerStateSnapshotListingError>

List all LedgerStateSnapshot in a given directory.

pub fn get_files_relative_path(&self) -> Vec<PathBuf>

Return paths to all files that constitute this snapshot

Returned path are relative to the cardano node database ledger dir

pub fn slot_number(&self) -> SlotNumber

Return the slot number when this snapshot was taken

Trait Implementations

impl Clone for LedgerStateSnapshot

fn clone(&self) -> LedgerStateSnapshot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LedgerStateSnapshot

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

Formats the value using the given formatter.

impl Ord for LedgerStateSnapshot

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

Restrict a value to a certain interval.

impl PartialEq for LedgerStateSnapshot

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for LedgerStateSnapshot

impl StructuralPartialEq for LedgerStateSnapshot