ic-memory 0.39.13

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::{key::StableKey, slot::AllocationSlotDescriptor};

///
/// AllocationPolicy
///
/// Framework-supplied rules for whether a key may claim a slot.
pub trait AllocationPolicy {
    /// Policy error type.
    type Error;

    /// Validate a stable key against framework naming rules.
    fn validate_key(&self, key: &StableKey) -> Result<(), Self::Error>;

    /// Validate a stable-key to allocation-slot claim.
    fn validate_slot(
        &self,
        key: &StableKey,
        slot: &AllocationSlotDescriptor,
    ) -> Result<(), Self::Error>;

    /// Validate a reserved stable-key to allocation-slot claim.
    fn validate_reserved_slot(
        &self,
        key: &StableKey,
        slot: &AllocationSlotDescriptor,
    ) -> Result<(), Self::Error>;
}

///
/// NamespaceAuthority
///
/// Policy-owned stable-key namespace ownership.
pub trait NamespaceAuthority {
    /// Return true when this authority owns `key`.
    fn owns(&self, key: &StableKey) -> bool;
}

///
/// RangeAuthority
///
/// Optional substrate-specific range authority validation.
pub trait RangeAuthority {
    /// Range validation error type.
    type Error;

    /// Validate one allocation slot against the authority.
    fn validate_slot(&self, slot: &AllocationSlotDescriptor) -> Result<(), Self::Error>;
}