Expand description
APIs to make and manage calls in the canister.
Structs§
- ArgDecoder
Config - Config to control the behavior of decoding canister endpoint arguments.
- Call
Reply Writer - An io::Write for message replies.
- Manual
Reply - Pretends to have the Candid type
T, but unconditionally errors when serialized.
Enums§
- Rejection
Code - Rejection code from calling another canister.
Functions§
- accept_
message - Accepts the ingress message.
- arg_
data - Returns the argument data in the current call. Traps if the data cannot be decoded.
- arg_
data_ raw - Returns the argument data as bytes.
- arg_
data_ raw_ size - Gets the len of the raw-argument-data-bytes.
- call
- Performs an asynchronous call to another canister.
- call_
raw - Performs an asynchronous call to another canister and pay cycles at the same time.
- call_
raw128 - Performs an asynchronous call to another canister and pay cycles (in
u128) at the same time. - call_
with_ config - Performs an asynchronous call to another canister and pay cycles (in
u128). It also allows setting a quota for decoding the return values. The decoding quota is strongly recommended when calling third-party or untrusted canisters. - call_
with_ payment - Performs an asynchronous call to another canister and pay cycles at the same time.
- call_
with_ payment128 - Performs an asynchronous call to another canister and pay cycles (in
u128) at the same time. - is_
recovering_ from_ trap - Tells you whether the current async fn is being canceled due to a trap/panic.
- method_
name - Returns the name of current canister method.
- msg_
cycles_ accept - Moves cycles from the call to the canister balance.
- msg_
cycles_ accept128 - Moves cycles from the call to the canister balance.
- msg_
cycles_ available - Returns the amount of cycles that were transferred by the caller of the current call, and is still available in this message.
- msg_
cycles_ available128 - Returns the amount of cycles that were transferred by the caller of the current call, and is still available in this message.
- msg_
cycles_ refunded - Returns the amount of cycles that came back with the response as a refund.
- msg_
cycles_ refunded128 - Returns the amount of cycles that came back with the response as a refund.
- notify
- Like notify_with_payment128, but sets the payment to zero.
- notify_
raw - Like notify, but sends the argument as raw bytes, skipping Candid serialization.
- notify_
with_ payment128 - Sends a one-way message with
paymentcycles attached to it that invokesmethodwith argumentsargson the principal identified byid, ignoring the reply. - performance_
counter Deprecated - Gets the value of specified performance counter
- reject
- Rejects the current call with the message.
- reject_
code - Returns the rejection code for the call.
- reject_
message - Returns the rejection message.
- reply
- Replies to the current call with a candid argument.
- reply_
raw - Replies with the bytes passed
- result
- Returns a result that maps over the call
Type Aliases§
- Call
Result - The result of a Call.