Expand description
APIs to manage stable memory.
You can check the Internet Computer Specification for a in-depth explanation of stable memory.
Structs§
- Buffered
Stable Reader - A reader to the stable memory which reads bytes a chunk at a time as each chunk is required.
- Buffered
Stable Writer - A writer to the stable memory which first writes the bytes to an in memory buffer and flushes the buffer to stable memory each time it becomes full.
- Canister
Stable Memory - A standard implementation of
StableMemory. - StableIO
- Performs generic IO (read, write, and seek) on stable memory.
- Stable
Reader - Keeps an offset and reads off stable memory consecutively.
- Stable
Writer - A writer to the stable memory.
Enums§
- Stable
Memory Error - A possible error value when dealing with stable memory.
Constants§
- WASM_
PAGE_ SIZE_ IN_ BYTES - WASM page size in bytes.
Traits§
- Stable
Memory - A trait defining the stable memory API which each canister running on the IC can make use of
Functions§
- stable64_
grow - Similar to
stable_growbut with support for 64-bit addressed memory. - stable64_
read - Similar to
stable_readbut with support for 64-bit addressed memory. - stable64_
size - Similar to
stable_sizebut with support for 64-bit addressed memory. - stable64_
write - Similar to
stable_writebut with support for 64-bit addressed memory. - stable_
bytes - Returns a copy of the stable memory.
- stable_
grow - Attempts to grow the stable memory by
new_pages(added pages). - stable_
read - Reads data from the stable memory location specified by an offset.
- stable_
size - Gets current size of the stable memory (in WASM pages).
- stable_
write - Writes data to the stable memory location specified by an offset.