Trait ic_kit::Context

source · [−]
pub trait Context {

Show 26 methods    fn trap(&self, message: &str) -> !;
    fn print<S: AsRef<str>>(&self, s: S);
    fn id(&self) -> Principal;
    fn time(&self) -> u64;
    fn balance(&self) -> u64;
    fn caller(&self) -> Principal;
    fn msg_cycles_available(&self) -> u64;
    fn msg_cycles_accept(&self, amount: u64) -> u64;
    fn msg_cycles_refunded(&self) -> u64;
    fn store<T: 'static>(&self, data: T);
    fn get_maybe<T: 'static>(&self) -> Option<&T>;
    fn get_mut<T: 'static + Default>(&self) -> &mut T;
    fn delete<T: 'static + Default>(&self) -> bool;
    fn stable_store<T>(&self, data: T) -> Result<(), Error>
    where
        T: ArgumentEncoder;
    fn stable_restore<T>(&self) -> Result<T, String>
    where
        T: for<'de> ArgumentDecoder<'de>;
    fn call_raw<S: Into<String>>(
        &'static self,
        id: Principal,
        method: S,
        args_raw: Vec<u8>,
        cycles: u64
    ) -> CallResponse<Vec<u8>>;
    fn set_certified_data(&self, data: &[u8]);
    fn data_certificate(&self) -> Option<Vec<u8>>;
    fn spawn<F: 'static + Future<Output = ()>>(&mut self, future: F);
    fn stable_size(&self) -> u32;
    fn stable_grow(&self, new_pages: u32) -> Result<u32, StableMemoryError>;
    fn stable_write(&self, offset: u32, buf: &[u8]);
    fn stable_read(&self, offset: u32, buf: &mut [u8]);

    fn get<T: 'static + Default>(&self) -> &T { ... }
    fn call<T: ArgumentEncoder, R: for<'a> ArgumentDecoder<'a>, S: Into<String>>(
        &'static self,
        id: Principal,
        method: S,
        args: T
    ) -> CallResponse<R> { ... }
    fn call_with_payment<T: ArgumentEncoder, R: for<'a> ArgumentDecoder<'a>, S: Into<String>>(
        &'static self,
        id: Principal,
        method: S,
        args: T,
        cycles: u64
    ) -> CallResponse<R> { ... }

}

Required Methods

Trap the code.

Print a message.

ID of the current canister.

The time in nanoseconds.

The balance of the canister.

The caller who has invoked this method on the canister.

Return the number of available cycles that is sent by the caller.

Accept the given amount of cycles, returns the actual amount of accepted cycles.

Return the cycles that were sent back by the canister that was just called. This method should only be called right after an inter-canister call.

Store the given data to the storage.

Return the data that does not implement Default.

Return a mutable reference to the given data type, if the data is not present the default value of the type is constructed and stored. The changes made to the data during updates is preserved.

Remove the data associated with the given data type.

Store the given data to the stable storage.

Restore the data from the stable storage. If the data is not already stored the None value is returned.

Perform a call.

Set the certified data of the canister, this method traps if data.len > 32.

Returns the data certificate authenticating certified_data set by this canister.

Execute a future without blocking the current call.

Returns the current size of the stable memory in WebAssembly pages. (One WebAssembly page is 64KiB)

Tries to grow the memory by new_pages many pages containing zeroes. This system call traps if the previous size of the memory exceeds 2^32 bytes. Errors if the new size of the memory exceeds 2^32 bytes or growing is unsuccessful. Otherwise, it grows the memory and returns the previous size of the memory in pages.

Writes data to the stable memory location specified by an offset.

Reads data from the stable memory location specified by an offset.

Provided Methods

Return the data associated with the given type. If the data is not present the default value of the type is returned.

Perform the call and return the response.

Implementors