Crate ic_cdk_macros

ic-cdk-macros

This crate provides a set of macros to facilitate canister development.

The macros fall into two categories:

• To register functions as canister entry points
• To export Candid definitions

Register functions as canister entry points

These macros are directly related to the Internet Computer Specification.

• init
• pre_upgrade
• post_upgrade
• inspect_message
• heartbeat
• update
• query

Export Candid definitions

• export_candid

Check Generating Candid files for Rust canisters for more details.

Macros

• export_candid
  Create a get_candid_pointer method so that dfx can execute it to extract candid definition.

Attribute Macros

• heartbeat
  Register the canister_heartbeat entry point of a canister.
• init
  Register the canister_init entry point of a canister.
• inspect_message
  Register the canister_inspect_message entry point of a canister.
• post_upgrade
  Register the canister_post_upgrade entry point of a canister.
• pre_upgrade
  Register the canister_pre_upgrade entry point of a canister.
• query
  Register a query call entry point.
• update
  Register an update call entry point.