canic-core 0.110.2

Canic — a canister orchestration and management toolkit for the Internet Computer
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
49
50
51
52
53
54
55
56
57
58
59
60
61

//! Persisted record and stable-memory representation.
//!
//! This module contains passive persisted and cached representations. Model
//! owns authoritative state and storage invariants; ops owns access and
//! conversion at this boundary.
//!
//! Multi-step orchestration lives in `workflow`; pure decision helpers live in
//! `domain::policy::pure`.

pub mod canister;
pub mod stable;

///
/// Prelude
///

pub mod prelude {
    pub use crate::impl_storable_bounded;
    pub use crate::{
        cdk::types::{Cycles, Principal},
        eager_static,
        ids::{CanisterRole, ComponentSpecId, ManagedCanisterBinding},
    };
    pub use serde::{Deserialize, Serialize};
}

use crate::InternalError;
use thiserror::Error as ThisError;

///
/// StorageError
///

#[derive(Debug, ThisError)]
pub enum StorageError {
    #[error("runtime log count invariant is inconsistent")]
    LogCountInvariant,

    #[error("runtime log sequence {0} already exists")]
    LogSequenceConflict(u64),

    #[error("runtime log sequence exhausted")]
    LogSequenceExhausted,

    #[error("runtime log timestamp regressed from {previous} to {current}")]
    LogTimestampRegressed { previous: u64, current: u64 },
}

impl From<StorageError> for InternalError {
    fn from(err: StorageError) -> Self {
        use crate::diagnostics::codes;

        let code = match err {
            StorageError::LogCountInvariant => codes::STATE_INVALID,
            StorageError::LogSequenceConflict(_) => codes::POSITION_CONFLICT,
            StorageError::LogSequenceExhausted => codes::VERSION_CAPACITY,
            StorageError::LogTimestampRegressed { .. } => codes::TIME_ORDERING,
        };
        Self::public(code)
    }
}