tokio-rs/axum

full scan as JSON

• Comprehensive documentation standardsCreate clear, well-structured API documentation following proper formatting, correct references, informative examples, and completeness s...

  tokio-rs/axum Documentation Rust app-frameworks

  copy raw open
• Type-safe flexible APIsDesign APIs that favor both type safety and flexibility. Use strongly typed wrappers instead of primitive types, but accept generic param...

  tokio-rs/axum API Rust app-frameworks

  copy raw open
• Axum Code Review: Interaction PatternsWhen implementing Axum-based applications, it is crucial to ensure that the interaction patterns between components are well-designed and...

  tokio-rs/axum Axum TypeScript app-frameworks

  copy raw open
• Prefer simpler code constructsAlways opt for simpler, more idiomatic code constructs over complex or verbose alternatives. This includes using built-in Rust patterns i...

  tokio-rs/axum Code Style Rust app-frameworks

  copy raw open
• Consistent axum Usage in TypeScriptWhen implementing TypeScript code that uses the axum package, maintain consistent and idiomatic usage: always use lowercase 'axum', lever...

  tokio-rs/axum Axum TypeScript app-frameworks

  copy raw open
• Documentation consistency standardsMaintain consistent documentation formatting standards across all project files, especially in changelogs, code examples, and technical d...

  tokio-rs/axum Documentation Markdown app-frameworks

  copy raw open
• Prefer descriptive over briefChoose clear, descriptive names over abbreviated or shortened versions. Names should be self-documenting and follow Rust conventions. Whi...

  tokio-rs/axum Naming Conventions Rust app-frameworks

  copy raw open
• Handle protocol headers properlyWhen implementing network services, especially proxies and protocol handlers, proper HTTP header management is critical for correct funct...

  tokio-rs/axum Networking Rust app-frameworks

  copy raw open
• Lock carefully in asyncWhen using locks in async code, follow critical guidelines to avoid deadlocks. Never hold std::sync::Mutex locks across .await points as ...

  tokio-rs/axum Concurrency Rust app-frameworks

  copy raw open
• Minimize memory allocation overheadOptimize performance by minimizing unnecessary memory allocations and using allocation-efficient APIs. Key practices include using static...

  tokio-rs/axum Performance Optimization Rust app-frameworks

  copy raw open
• Structure errors for safetyCreate specific error types with appropriate status codes while ensuring sensitive details are logged but not exposed to clients. Follow ...

  tokio-rs/axum Error Handling Rust app-frameworks

  copy raw open
• Use Option combinatorsInstead of verbose conditional logic, prefer Rust's Option combinators like map, and_then, and filter for handling potentially null value...

  tokio-rs/axum Null Handling Rust app-frameworks

  copy raw open
• Document feature flagsWhen configuring feature flags in Cargo.toml, ensure they are properly structured and documented. Chain feature dependencies correctly, d...

  tokio-rs/axum Configurations TOML app-frameworks

  copy raw open
• Implement Distributed Tracing in Axum ApplicationsAs an Axum code reviewer, I recommend implementing proper distributed tracing in your Axum-based web applications to ensure observability...

  tokio-rs/axum Axum TypeScript app-frameworks

  copy raw open
• Use Appropriate Concurrency Patterns with AxumWhen building asynchronous Axum applications that share mutable state, it's important to select the right concurrency mechanisms. Use Axu...

  tokio-rs/axum Axum TypeScript app-frameworks

  copy raw open
• Secure cookie configurationAlways set appropriate security flags on cookies, especially those used for authentication or session management. At minimum, include Htt...

  tokio-rs/axum Security Rust app-frameworks

  copy raw open