RU
Rust API Guidelines
Used in 53 rust projects (avg ★13)
Details
RustRules
balanced
- Use snake_case for functions, variables, and modules with descriptive names including auxiliary verbs (e.g., is_valid, has_error).
- Handle errors early using guard clauses, early returns, and the ? operator.
- Minimize allocations in hot paths; prefer zero-copy operations and static data where possible.
- Modularize code to avoid duplication, favoring iteration over repetition.
- Separate policy and metadata management from core storage for cleaner APIs.
- Prefer contiguous storage with index-based indirection over scattered pointers or dynamic structures.
- Design concurrency explicitly from the start (e.g., sharding or lock-free) rather than as an afterthought.
- Document all public items with `///` doc comments — include a `# Examples` section with a runnable `doctest` and `# Errors` / `# Panics` / `# Safety` sections where applicable.
- Implement structured logging with contextual fields for better observability.