ic_cdk::api

Module call

Source
Expand description

APIs to make and manage calls in the canister.

Structs§

  • Config to control the behavior of decoding canister endpoint arguments.
  • An io::Write for message replies.
  • Pretends to have the Candid type T, but unconditionally errors when serialized.

Enums§

Functions§

  • Accepts the ingress message.
  • Returns the argument data in the current call. Traps if the data cannot be decoded.
  • Returns the argument data as bytes.
  • Gets the len of the raw-argument-data-bytes.
  • Performs an asynchronous call to another canister.
  • Performs an asynchronous call to another canister and pay cycles at the same time.
  • Performs an asynchronous call to another canister and pay cycles (in u128) at the same time.
  • 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.
  • Performs an asynchronous call to another canister and pay cycles at the same time.
  • Performs an asynchronous call to another canister and pay cycles (in u128) at the same time.
  • Tells you whether the current async fn is being canceled due to a trap/panic.
  • Returns the name of current canister method.
  • Moves cycles from the call to the canister balance.
  • Moves cycles from the call to the canister balance.
  • Returns the amount of cycles that were transferred by the caller of the current call, and is still available in this message.
  • Returns the amount of cycles that were transferred by the caller of the current call, and is still available in this message.
  • Returns the amount of cycles that came back with the response as a refund.
  • Returns the amount of cycles that came back with the response as a refund.
  • Like notify_with_payment128, but sets the payment to zero.
  • Like notify, but sends the argument as raw bytes, skipping Candid serialization.
  • Sends a one-way message with payment cycles attached to it that invokes method with arguments args on the principal identified by id, ignoring the reply.
  • Gets the value of specified performance counter
  • Rejects the current call with the message.
  • Returns the rejection code for the call.
  • Returns the rejection message.
  • Replies to the current call with a candid argument.
  • Replies with the bytes passed
  • Returns a result that maps over the call

Type Aliases§