Struct ic_cdk::api::stable::CanisterStableMemory
source · pub struct CanisterStableMemory {}
Expand description
A standard implementation of StableMemory
.
Useful for creating StableWriter
and StableReader
.
Trait Implementations
sourceimpl Default for CanisterStableMemory
impl Default for CanisterStableMemory
sourcefn default() -> CanisterStableMemory
fn default() -> CanisterStableMemory
Returns the “default value” for a type. Read more
sourceimpl StableMemory for CanisterStableMemory
impl StableMemory for CanisterStableMemory
sourcefn stable_size(&self) -> u32
fn stable_size(&self) -> u32
Gets current size of the stable memory (in WASM pages).
sourcefn stable64_size(&self) -> u64
fn stable64_size(&self) -> u64
Similar to
stable_size
but with support for 64-bit addressed memory.sourcefn stable_grow(&self, new_pages: u32) -> Result<u32, StableMemoryError>
fn stable_grow(&self, new_pages: u32) -> Result<u32, StableMemoryError>
Attempts to grow the stable memory by
new_pages
(added pages). Read moresourcefn stable64_grow(&self, new_pages: u64) -> Result<u64, StableMemoryError>
fn stable64_grow(&self, new_pages: u64) -> Result<u64, StableMemoryError>
Similar to
stable_grow
but with support for 64-bit addressed memory.sourcefn stable_write(&self, offset: u32, buf: &[u8])
fn stable_write(&self, offset: u32, buf: &[u8])
Writes data to the stable memory location specified by an offset. Read more
sourcefn stable64_write(&self, offset: u64, buf: &[u8])
fn stable64_write(&self, offset: u64, buf: &[u8])
Similar to
stable_write
but with support for 64-bit addressed memory.sourcefn stable_read(&self, offset: u32, buf: &mut [u8])
fn stable_read(&self, offset: u32, buf: &mut [u8])
Reads data from the stable memory location specified by an offset.
sourcefn stable64_read(&self, offset: u64, buf: &mut [u8])
fn stable64_read(&self, offset: u64, buf: &mut [u8])
Similar to
stable_read
but with support for 64-bit addressed memory.Auto Trait Implementations
impl RefUnwindSafe for CanisterStableMemory
impl Send for CanisterStableMemory
impl Sync for CanisterStableMemory
impl Unpin for CanisterStableMemory
impl UnwindSafe for CanisterStableMemory
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more