rust

Files (7)

• SKILL.md
• API_DESIGN.md · references/
• CRATES.md · references/
• ERRORS.md · references/
• PERFORMANCE.md · references/
• SAFETY.md · references/
• VERIFICATION.md · references/

SKILL.md (first lines)

# Rust

Write small, idiomatic, readable Rust. Prefer clarity over cleverness.
Respect the repo's toolchain, and prove changes with the standard gate before
calling them done. Each principle below has a reference; load it when a change
goes deep in that area, not for routine edits.

Resist: hiding errors with `unwrap`/`expect`/`panic`/`assert` on user-controlled input,
adding crates that don't cut real complexity, clever code.

- Respect repo `rust-toolchain.toml`/`rust-toolchain` first; `rustup` for toolchains,
  `cargo` for tasks. Scan before edits: `rustup show active-toolchain`,
  `cargo metadata --no-deps --format-version 1`, `cargo check`; read `AGENTS.md`, architecture, README.
- Errors are typed and surfaced — libraries return `Result<T, Error>` with typed errors;
  apps print a concise top-level error and exit non-zero. A detected programming bug or
  broken invariant panics; genuinely fallible input returns `Result`. Default to `snafu`
  for new library and application error handling. Preserve established error crates
  unless migration is approved; hand-implement `std::error::Error` in zero-dep projects.
  When choosing or changing error handling, read `references/ERRORS.md`.
- Add a crate only when it reduces meaningful complexity, and say why; avoid broad
  frameworks in small CLIs. Preferred picks by task: `references/CRATES.md`.
- Keep `src/main.rs` thin (parse → call lib → print); logic in `src/lib.rs`, modules by
  domain (parser, renderer, cli, error). Use the strongest type as early as possible
  (`&str`/`Path` over `String`/`PathBuf`, newtypes over loose primitives); validate bounds
  before slicing; `*::from_le_bytes` for binary; test malformed input and edge offsets.
  Idiomatic API, library, and doc design: `references/API_DESIGN.md`. For `unsafe`/FFI:
  `references/SAFETY.md`. For hot paths: `references/PERFORMANCE.md`.
- Verify before done: `cargo fmt -- --check`, `cargo clippy --all-targets -- -D warnings`,
  `cargo test`, `cargo check` (add `rustfmt`/`clippy` components if missing). Recommended
  lint config and deeper checks (`cargo-audit`/`-hack`/`-udeps`, Miri): `references/VERIFICATION.md`.

Deliver: the change, why any new crate earned its place, and the verification results.

From bryan824/kirin-pi, MIT.

More from bryan824/kirin-pi