rust

Rust Project Rules

Stack policy: PoolAI product code is Rust-only (plus src/ui/ JS). Do not add Python runtime, requirements.txt, or Python sidecars. See .cursor/rules/runtime-stack-policy.mdc.

Commands

• cargo check: Check code compilation without building
• cargo build: Build the project
• cargo build --release: Build optimized release version
• cargo test: Run all tests (prefer single test files for speed: cargo test --test <test_file>)
• cargo fmt: Format code (always run before commit)
• cargo clippy: Run linter (always run before commit)
• cargo doc --open: Generate and open documentation
• cargo run: Run the main binary
• cargo run --features enterprise: Run with enterprise features
• cargo run --features jwt: Run with JWT authentication
• cargo run --features https: Run with HTTPS support

Code Style

• Use Rust Edition 2021 conventions
• Follow Rust naming conventions: snake_case for functions/variables, PascalCase for types
• Use pub only when necessary - prefer private by default
• Use Arc<RwLock<T>> for shared mutable state across async tasks
• Use Option<T> and Result<T, E> for error handling - never use unwrap() in production code
• Use async/await for I/O operations, prefer tokio runtime
• Use tracing for logging: info!(), warn!(), error!(), debug!()
• See src/core/error.rs for canonical error handling patterns
• See src/raid/mod.rs for canonical module structure with mod.rs

Module Structure

• Each module has a mod.rs file
• Sub-modules in separate files (e.g., src/raid/burst_raid.rs)
• Public API exported through pub use in mod.rs
• Private implementation details stay in sub-modules
• See src/lib.rs for public API structure

Error Handling

• Use AppError from crate::core::error::AppError
• Always provide context and suggestions in error messages
• Use ? operator for error propagation
• Never use unwrap() or expect() in production code
• Use Result<T, AppError> for fallible operations