interface-design-review

To review a Rust API for misuse resistance, analyze public traits, structs, and module boundaries to ensure the type system makes correct usage easy and incorrect usage hard. Prioritize compile-time safety over runtime checks and validation at boundaries.

The enforcement hierarchy for safe Rust interfaces prioritizes making invalid states unrepresentable through the type system, then compile-time checks, runtime validation at boundaries, and finally documentation. This spectrum guides developers to prevent errors early.

Prevent invalid states in Rust structs by enforcing invariants through the type system, making incorrect data unrepresentable. Validate data at module boundaries so callers interact only with safe, valid types, ensuring compiler resistance to misuse.

Use compile-time safety over runtime checks in Rust API design whenever the type system can enforce invariants and make invalid states unrepresentable. This approach eliminates entire classes of runtime errors and guides callers toward correct behavior.

Yes, the interface review tool analyzes existing Rust libraries by examining their public APIs, traits, structs, and module boundaries. It evaluates current designs against an enforcement hierarchy to identify where type system changes can improve safety and developer experience.

Common Rust API design issues include allowing invalid states to be representable, over-relying on runtime checks instead of type enforcement, and poorly defined module boundaries. These flaws make APIs easy to misuse and degrade developer experience.