Rust Coding Style

Rust Coding Style

Project-Specific Patterns

• Use the 2024 edition of Rust
• Prefer derive_more over manual trait implementations
• Feature flags in this codebase use the #[cfg(feature = "...")] pattern
• Invoke cargo clippy with --all-features, --all-targets, and --no-deps from the root
• Use cargo doc --no-deps --all-features for checking documentation
• Use rustfmt to format the code
• Use #[expect(lint, reason = "...")] over #[allow(lint)]

Type System

• Create strong types with newtype patterns for domain entities
• Consider visibility carefully (avoid unnecessary pub)

#[derive(Debug, Copy, Clone, Eq, Hash, PartialEq, derive_more::Display)]
pub struct UserId(Uuid);

Async Patterns

• Use impl Future<Output = T> + Send in trait definitions:

fn get_data(
    &self,
    id: String,
) -> impl Future<Output = Result<Data, Report<DataError>>> + Send {
    async move {
        // Implementation
    }
}

Function Arguments

• Functions should never take more than 7 arguments. If a function requires more than 7 arguments, encapsulate related parameters in a struct.