Rust Module Organization & Public API Design

What problem does it solve?

This Skill addresses the challenge of organizing Rust code effectively, ensuring a clear separation between internal implementation details and the public API, which is crucial for maintainability and preventing breaking changes.

Core Features & Use Cases

• Module Structure: Guides on organizing code into logical modules based on features and domain.
• Public API Definition: Best practices for defining a stable and user-friendly public API through re-exports in lib.rs.
• Visibility Control: Explains the use of pub, pub(crate), and pub(super) for precise control over item visibility.
• Feature Gates: Demonstrates how to use Cargo features to conditionally expose API elements.
• API Validation: Introduces cargo-public-api for tracking and preventing breaking changes.
• Use Case: A Rust library maintainer needs to refactor their codebase to ensure a clean public API and prevent accidental exposure of internal implementation details, while also preparing for future feature additions.

Quick Start

Apply the principles of Rust module organization and public API design to structure your library's codebase for clarity and stability.