ic-memory 0.39.11

Persistent allocation-governance infrastructure for Internet Computer stable memory
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

use crate::{declaration::DeclarationSnapshot, ledger::GenerationRecord};
use serde::{Deserialize, Serialize};

///
/// GenerationMutation
///
/// One staged allocation-history mutation.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub enum GenerationMutation {
    /// Add or confirm an active allocation declaration.
    Declare,
    /// Add or confirm a reserved allocation declaration.
    Reserve,
    /// Explicitly retire an allocation.
    Retire,
    /// Record schema metadata drift for diagnostics.
    RecordSchemaMetadata,
}

///
/// StagedGeneration
///
/// Generation prepared for atomic commit.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct StagedGeneration {
    /// Generation number to commit.
    pub generation: u64,
    /// Parent generation that remains authoritative until commit succeeds.
    pub parent_generation: u64,
    /// Snapshot being committed.
    pub snapshot: DeclarationSnapshot,
    /// Staged mutations included in this generation.
    pub mutations: Vec<GenerationMutation>,
}

///
/// GenerationCommit
///
/// Protected commit metadata for a generation.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct GenerationCommit {
    /// Committed generation record.
    pub record: GenerationRecord,
    /// Protected commit checksum supplied by the physical format.
    pub checksum: u64,
    /// Physical commit marker supplied by the physical format.
    pub commit_marker: u64,
}