b3_utils 0.13.1

Utility functions for building on 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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

use super::{
    error::StableMemoryError,
    timer::DefaultTaskTimer,
    types::{
        DefaultStableBTreeMap, DefaultStableCell, DefaultStableLog, DefaultStableMinHeap,
        DefaultStableVec, DefaultVM,
    },
};

pub use ic_stable_structures::{
    cell::InitError as ExternalCellInitError, log::InitError as ExternalLogInitError,
    memory_manager::VirtualMemory, DefaultMemoryImpl, FileMemory, Memory, RestrictedMemory,
    StableBTreeMap, StableCell, StableLog, StableMinHeap, StableVec, Storable, VectorMemory,
};

#[rustfmt::skip]
pub enum InitMemoryArg {
    Single(DefaultVM),
    Double(DefaultVM, DefaultVM),
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum MemoryType {
    Map,
    Vec,
    Log,
    Cell,
    Heap,
    Timer,
}

pub trait InitMemory<T>: Sized {
    fn memory_type() -> MemoryType;
    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError>;
}

impl<T: Storable> InitMemory<DefaultStableVec<T>> for DefaultStableVec<T> {
    fn memory_type() -> MemoryType {
        MemoryType::Vec
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Single(memory) = arg {
            StableVec::init(memory)
                .map_err(|e| StableMemoryError::UnableToCreateMemory(e.to_string()))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}

impl<K: Ord + Storable + Clone, V: Storable> InitMemory<DefaultStableBTreeMap<K, V>>
    for DefaultStableBTreeMap<K, V>
{
    fn memory_type() -> MemoryType {
        MemoryType::Map
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Single(memory) = arg {
            Ok(StableBTreeMap::init(memory))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}

impl<T: Storable> InitMemory<DefaultStableLog<T>> for DefaultStableLog<T> {
    fn memory_type() -> MemoryType {
        MemoryType::Log
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Double(index_memory, data_memory) = arg {
            StableLog::init(index_memory, data_memory)
                .map_err(|e| StableMemoryError::UnableToCreateMemory(e.to_string()))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}

impl<T: Storable + Default> InitMemory<DefaultStableCell<T>> for DefaultStableCell<T> {
    fn memory_type() -> MemoryType {
        MemoryType::Cell
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Single(memory) = arg {
            StableCell::init(memory, T::default())
                .map_err(|e| StableMemoryError::UnableToCreateMemory(e.to_string()))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}

impl<T: Ord + Storable> InitMemory<DefaultStableMinHeap<T>> for DefaultStableMinHeap<T> {
    fn memory_type() -> MemoryType {
        MemoryType::Heap
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Single(memory) = arg {
            DefaultStableMinHeap::init(memory)
                .map_err(|e| StableMemoryError::UnableToCreateMemory(e.to_string()))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}

impl<T: Storable + Clone> InitMemory<DefaultTaskTimer<T>> for DefaultTaskTimer<T> {
    fn memory_type() -> MemoryType {
        MemoryType::Timer
    }

    fn init(arg: InitMemoryArg) -> Result<Self, StableMemoryError> {
        if let InitMemoryArg::Single(memory) = arg {
            DefaultTaskTimer::init(memory)
                .map_err(|e| StableMemoryError::UnableToCreateMemory(e.to_string()))
        } else {
            Err(StableMemoryError::WrongInitializationArgument)
        }
    }
}