Module ic_kit::ic

System APIs for the Internet Computer.

Structs

CallBuilder

A call builder that let’s you create an inter-canister call which can be then sent to the destination.

Enums

CallError

Constants

CANDID_EMPTY_ARG

The result of candid::encode_args(()) which is used as the default argument.

Functions

balance

The balance of the canister.

caller

The caller who has invoked this method on the canister.

data_certificate

Returns the data certificate authenticating certified_data set by this canister.

id

ID of the current canister.

maybe_with

Like with, but does not initialize the data with the default value and simply returns None, if there is no value associated with the type.

maybe_with_mut

Like with_mut, but does not initialize the data with the default value and simply returns None, if there is no value associated with the type.

msg_cycles_accept

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

msg_cycles_available

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

msg_cycles_refunded

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.

print

Print a debug message from the canister that can be viewed during local development.

set_certified_data

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

spawn

Execute a future without blocking the current call. The given future is polled once initially to kickstart the async calls.

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

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

stable_write

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

swap

Swaps the value associated with type T with the given value, returns the old one.

take

Remove the current value associated with the type and return it.

time

The time in nanoseconds.

trap

Trap the canister with the provided message. This will rollback the canister state at the beginning of the current entry point, consider rejecting the message gracefully.

with

Pass an immutable reference to the value associated with the given type to the closure.

with_many

Like crate::ic::with but passes the immutable reference of multiple variables to the closure as a tuple.

with_many_mut

Like crate::ic::with_mut but passes the mutable reference of multiple variables to the closure as a tuple.

with_mut

Pass a mutable reference to the value associated with the given type to the closure.

Type Definitions

Cycles

The type used to represent the cycles amount, which is u128 when the experimental-cycles128 feature is on and a u64 otherwise.

StableSize

A type which represents either a page count or an offset in the stable storage, it’s a u64 when the experimental-stable64 feature is enabled, otherwise a u32.