菜单
Use when defining a public `enum` or `struct` in a library crate that may gain variants or fields later — keep future additions from being breaking changes.
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
基于 SOC 职业分类
Enforce type-signature conventions for public Miden Assembly (.masm) procedures. Use when adding, editing, or reviewing a `pub proc` signature — parameter and return types, semantic type aliases, struct/array/tuple types, and how the signature maps onto the operand stack and the doc-comment Inputs/Outputs.
Enforce inline commenting conventions for Miden Assembly (.masm) files. Use when editing, reviewing, or creating .masm files.
Enforce doc comment conventions for Miden Assembly (.masm) procedures. Use when editing, reviewing, or creating .masm procedures, especially when documenting inputs, outputs, panic conditions, or invocation types.
Use when writing kernel, account, or note MASM code that reads from or writes to the advice provider (advice stack / advice map) — validate advice data.
Use when writing a Rust test that exercises a failure path or a MASM test that expects a `panic` / `assert` — assert on the specific expected error variant or error code.
Use when writing or reviewing MASM hot paths — prefer the cheaper equivalent instruction: `neq.0` over `gt.0` for non-zero checks, `cdrop` over an `if/else` selecting between two values, `dup.N` over `loc_load` for a value still on the stack, `eqw` over element-wise word comparison, `u32gt`/`u32lt` over generic `gt`/`lt` on known-u32 operands.
| name | non-exhaustive-public-types |
| description | Use when defining a public `enum` or `struct` in a library crate that may gain variants or fields later — keep future additions from being breaking changes. |
#[non_exhaustive]Public enums and public-fielded structs in library crates whose variants/fields are expected to grow should be marked #[non_exhaustive]:
#[non_exhaustive]
pub enum Authority {
AuthControlled,
OwnerControlled,
RbacControlled { role: RoleSymbol },
}
#[non_exhaustive]
pub struct Header {
pub version: u8,
pub flags: u32,
}
This forces external code to use a wildcard match arm (or default field syntax) and lets the library add new variants/fields in a minor release without breaking downstreams.
Don't mark types #[non_exhaustive] when the closed set is part of the contract — e.g. NoteType, a protocol-level enum fixed by the spec and serialized with a fixed-width discriminant, where adding a variant is a breaking protocol change anyway.
Without #[non_exhaustive], a downstream exhaustive match or struct literal compiles today but breaks the moment a minor release adds a variant or field. The attribute makes the wildcard arm mandatory, turning those additions from breaking to non-breaking.
// Good: a standards-level enum that is expected to gain variants over time
#[non_exhaustive]
pub enum TransferPolicy {
AllowAll,
Blocklist,
Allowlist { allow_list: AllowlistStorage },
Custom(AccountProcedureRoot),
}
// External callers are forced to include a wildcard, so a future variant
// (e.g. a time-locked or volume-limited policy) stays non-breaking:
match policy {
TransferPolicy::AllowAll => ...,
TransferPolicy::Blocklist => ...,
TransferPolicy::Allowlist { .. } => ...,
TransferPolicy::Custom(_) => ...,
_ => ..., // adding a variant in a minor release: still compiles
}
// Bad: closed public enum, so any new transfer policy is a breaking change
pub enum TransferPolicy {
AllowAll,
Blocklist,
Allowlist { allow_list: AllowlistStorage },
Custom(AccountProcedureRoot),
}