Skip to main content

AllocationLedger

Struct AllocationLedger 

Source
pub struct AllocationLedger { /* private fields */ }
Expand description

AllocationLedger

Durable root of allocation history.

Decoded ledgers are input from persistent storage and should be treated as untrusted until compatibility and integrity validation pass. Public construction goes through AllocationLedger::new, which validates structural history invariants before returning a value. Use AllocationLedger::new_committed when the value should also satisfy the strict committed-generation chain required by recovery and commit.

Implementations§

Source§

impl AllocationLedger

Source

pub fn validate_integrity(&self) -> Result<(), LedgerIntegrityError>

Validate structural ledger invariants before recovery or commit.

Source

pub fn validate_committed_integrity(&self) -> Result<(), LedgerIntegrityError>

Validate strict committed-ledger invariants before recovery or commit.

Public durable structs are DTOs: decoded or manually constructed values are untrusted until this method succeeds.

Source§

impl AllocationLedger

Source

pub fn new( ledger_schema_version: u32, physical_format_id: u32, current_generation: u64, allocation_history: AllocationHistory, ) -> Result<Self, LedgerIntegrityError>

Build a ledger DTO and validate structural ledger invariants.

This constructor validates duplicate records, lifecycle state, record generation bounds, and schema metadata records. It does not require a complete committed-generation chain. Use AllocationLedger::new_committed when constructing an authoritative committed ledger DTO.

Source

pub fn new_committed( ledger_schema_version: u32, physical_format_id: u32, current_generation: u64, allocation_history: AllocationHistory, ) -> Result<Self, LedgerIntegrityError>

Build a committed ledger DTO and validate strict committed-history invariants.

This constructor runs the same committed-integrity checks used by recovery and commit. Use it when the value should be treated as an authoritative committed ledger, not merely as a structurally valid DTO.

Source

pub const fn ledger_schema_version(&self) -> u32

Return the ledger schema version.

Source

pub const fn physical_format_id(&self) -> u32

Return the protected physical format identifier.

Source

pub const fn current_generation(&self) -> u64

Return the current committed generation selected by recovery.

Source

pub const fn allocation_history(&self) -> &AllocationHistory

Return the historical allocation facts.

Source§

impl AllocationLedger

Source

pub fn stage_validated_generation( &self, validated: &ValidatedAllocations, committed_at: Option<u64>, ) -> Result<Self, AllocationStageError>

Return a copy of the ledger with validated recorded as the next generation.

This is a pure logical update. Physical atomicity is the responsibility of the substrate commit protocol.

Source

pub fn stage_reservation_generation( &self, reservations: &[AllocationDeclaration], committed_at: Option<u64>, ) -> Result<Self, AllocationReservationError>

Return a copy of the ledger with reservations recorded as the next generation.

This is a pure logical update. The caller is responsible for applying framework policy before staging reservations.

Source

pub fn stage_retirement_generation( &self, retirement: &AllocationRetirement, committed_at: Option<u64>, ) -> Result<Self, AllocationRetirementError>

Return a copy of the ledger with one explicit retirement committed.

Trait Implementations§

Source§

impl Clone for AllocationLedger

Source§

fn clone(&self) -> AllocationLedger

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AllocationLedger

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AllocationLedger

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for AllocationLedger

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Serialize for AllocationLedger

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for AllocationLedger

Source§

impl StructuralPartialEq for AllocationLedger

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,