Crate ic_platform_macros 

ic-platform-macros

Implementation support for Platform’s optional cdk feature. This maintained Apache-2.0 generator derives from IC CDK 0.20.3 release revision 624606f7fd1ecd6668e9608594946486aec29167; its complete original license remains. It implements no executor or codec and requires no upstream change.

The default runtime path is ::ic_platform::cdk; a parsed crate = "module::path" override supports renamed dependencies. Every query/update explicitly supplies decode_with and encode_with (or manual_reply); even unit RPCs run their explicit decoder. Lifecycle argument decoding is explicit. Wire owns controlled application encoding and framing. Consumers own identities, guards and budgets. No implicit Candid endpoint codec, dummy service registration, Candid path option or service-export macro is retained. hidden = true remains accepted on existing Wire hook declarations and has no service-registration effect.

Export names, lifecycle restrictions, guard order, tuple/unit custom-encoder arity and sync/async/query contexts retain the reviewed generator behavior. Async entries use Platform’s preserved protected-spawn wrapper and the sole registry executor. IC_CDK_DEBUG retains opt-in expansion diagnostics. The support package and facade require coordinated next-minor publication.

Attribute Macros

heartbeat

Generate a heartbeat entrypoint in the shared runtime context.

init

Generate an initialization entrypoint with explicit argument decoding.

inspect_message

Generate a message inspection entrypoint in the shared runtime context.

on_low_wasm_memory

Generate a low-Wasm-memory entrypoint in the shared runtime context.

post_upgrade

Generate a post-upgrade entrypoint with explicit argument decoding.

pre_upgrade

Generate a pre-upgrade entrypoint in the shared runtime context.

query

Generate an explicit-codec query or composite-query entrypoint.

update

Generate an explicit-codec update entrypoint.