rust-unofficial/patterns

★ 8,796HandlebarsAudience · developerComplexity · 1/5LicenseSetup · easy

Mindmap

mindmap
  root((Rust Patterns))
    Content Types
      Design patterns
      Anti-patterns
      Idioms
    Audience
      Rust beginners to intermediate
      Developers from other languages
    How To Use
      Read online for free
      Download as PDF
      Build locally with mdBook
    Contributing
      Issue tracker for gaps
      Contribution guide

mindmap root((Rust Patterns)) Content Types Design patterns Anti-patterns Idioms Audience Rust beginners to intermediate Developers from other languages How To Use Read online for free Download as PDF Build locally with mdBook Contributing Issue tracker for gaps Contribution guide

Click or tap to explore — scroll the page freely

Things people build with this

USE CASE 1

Learn how experienced Rust developers structure code using reusable patterns like builder or newtype.

USE CASE 2

Look up common Rust anti-patterns to avoid mistakes when designing APIs or managing ownership.

USE CASE 3

Read about Rust idioms to make your code feel natural and familiar to other Rust programmers.

USE CASE 4

Build the book locally with mdBook to browse it offline or contribute a new pattern.

Tech stack

RustmdBook

Getting it running

Difficulty · easy Time to first run · 5min

Mozilla Public License 2.0, you can use and distribute the content, but modifications to MPL-licensed files must be shared under the same license.

In plain English

This repository is the source for an open book called "Rust Design Patterns," which catalogs common approaches, recurring patterns, anti-patterns, and idioms used when writing code in the Rust programming language. The book is readable online for free and can also be downloaded as a PDF. The content is aimed at people who already know Rust basics and want to understand how experienced Rust developers think about structuring code. Design patterns are general, reusable solutions to problems that come up often in software development. Anti-patterns are approaches that seem reasonable but tend to cause problems. Idioms are the small habits and conventions that make code feel natural to other Rust programmers. Covering all three categories in one place gives readers a more complete picture of what good Rust code looks like beyond just getting the syntax right. The book is built using a tool called mdBook, which converts plain-text Markdown source files into a website or PDF. If you want to read or build the book locally, you install mdBook through Rust's package manager and run a single build command. The repository itself is not a software library you import into a project, it is purely a documentation and reference resource. Contributions are welcome. The project maintains an issue tracker that lists patterns and topics not yet covered, and there is a contribution guide explaining the process for adding or improving content. There is no specific institution or company maintaining this book, it is a community effort under the rust-unofficial GitHub organization. The content is licensed under the Mozilla Public License 2.0.

Copy-paste prompts

Prompt 1

Explain the newtype pattern from Rust Design Patterns and show me a code example of when to use it.

Prompt 2

What does the Rust Design Patterns book say about the builder pattern and how do I implement it in Rust?

Prompt 3

Show me the anti-patterns the Rust Design Patterns book warns about when working with iterators.

Prompt 4

How do I build the Rust Design Patterns book locally using mdBook and what do I need to install first?

Open on GitHub → Explain another repo

← rust-unofficial on gitmyhub — every repo by this author, as a profile.

Verify against the repo before relying on details.