References

Published: 2023-05-29
Updated: 2024-03-02

Official 🔗

• Rust Cookbook
• API Guidelines Checklist
• Naming conventions - API Guide
• Documentation - API Guide
• Selecting a collection - Module std::collections
• Setting up defaults - Trait std::default::Default
• Attributes - The Rust Reference
  • Code like #![] and #[]
  • I always thought they were compiler directives
• Minimal Reproducible Example tips - Stack Overflow Rust Info
• Conditional Compilation
  • The Rust Reference
  • Internal Notes
• Managing External Processes - Rust Cookbook
• Testing CLI Applications by running them
  • CLI Book
  • Example Snippet
• Filing reports of unclear error messages (Choose Diagnostic) - Rust Issues
• Crate.io and Docs.rs issue status - https://status.crates.io/
• Build Queue for Docs.rs - docs.rs
• Raw Pointers - std docs
• Magic Completions - Rust Analyzer User Manual
• Directory Traversal - Rust Cookbook
• Recommended way to write expect messages - std docs
• Types of enum variants - Rust by Example

Reference Books (Also see Official) 🔗

• Collection patters, idioms and anti-patterns - Rust design patterns

Blog Posts 🔗

• Default arguments for functions in Rust using macros
• Explanation of Tracing Subscribers

Podcasts 🔗

• Rustacean Station - Current community run podcast
• New Rustacean - Stopped but it’s where I started. This podcast introduced me to rust and got me excited before I read the book and actually tried it myself (converted commute time into see if I like this rust thing time). I think the main reason it got me excited is that he spoke about the parts of rust that I was interested in and maybe contributed to making it easier to learn rust. I found learning rust easy but that’s not a sentiment I’ve heard from many other people so maybe this is why it was easy for me.

Video 🔗

See here for youtube videos.

Useful crates 🔗

For some crates I have more detailed notes. For those their page title starts with “Crate “. And for ease of maintenance they are not duplicated here. So please do see the section page for rust to see the list.

• log - A lightweight logging facade
• log4rs - a highly configurable logging framework modeled after Java’s Logback and log4j libraries.
  • Logging patterns patterns
• tracing
  • Shorthand Macros
• float_eq - Compare IEEE floating point primitives, structs and collections for equality
• float_ord - Add Ord for floats (used as FloatOrd(1.0))
• inventory - Typed distributed plugin registration.
• dirs - Helps you find the suitable directory to use in a cross platform way
• -secrecy - Simple secret keeping library. Small API surface and reasonable protection from mistakes.
• version - Easy way to check the version of a executable compiled with cargo (clap is probably better if it’s just to add a CLI arg to show to users)
• List of my crates on crates.io

GitHub Actions 🔗

• Toolchain

Lints 🔗

• The rustdoc book