2021-01-01 11:28:10 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js rust" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Introduction - Rust Design Patterns< / title >
<!-- Custom HTML head -->
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "A catalogue of Rust design patterns, anti-patterns and idioms" >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2022-01-17 20:53:51 +00:00
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2021-01-01 11:28:10 +00:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2022-01-17 20:53:51 +00:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2021-01-01 11:28:10 +00:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2022-01-17 20:53:51 +00:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2021-01-01 11:28:10 +00:00
<!-- Highlight.js Stylesheets -->
< link rel = "stylesheet" href = "highlight.css" >
< link rel = "stylesheet" href = "tomorrow-night.css" >
< link rel = "stylesheet" href = "ayu-highlight.css" >
<!-- Custom theme stylesheets -->
2022-01-17 20:53:51 +00:00
< / head >
2021-01-01 11:28:10 +00:00
< body >
<!-- Provide site root to javascript -->
< script type = "text/javascript" >
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "rust";
< / script >
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') & & theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') & & sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
< / script >
<!-- Set the theme before any content is loaded, prevents flash -->
< script type = "text/javascript" >
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('rust')
html.classList.add(theme);
html.classList.add('js');
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
< div class = "sidebar-scrollbox" >
2022-07-11 14:19:14 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "intro.html" class = "active" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "translations.html" > < strong aria-hidden = "true" > 1.1.< / strong > Translations< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "idioms/index.html" > < strong aria-hidden = "true" > 2.< / strong > Idioms< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "idioms/coercion-arguments.html" > < strong aria-hidden = "true" > 2.1.< / strong > Use borrowed types for arguments< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/concat-format.html" > < strong aria-hidden = "true" > 2.2.< / strong > Concatenating Strings with format!< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ctor.html" > < strong aria-hidden = "true" > 2.3.< / strong > Constructor< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/default.html" > < strong aria-hidden = "true" > 2.4.< / strong > The Default Trait< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/deref.html" > < strong aria-hidden = "true" > 2.5.< / strong > Collections Are Smart Pointers< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/dtor-finally.html" > < strong aria-hidden = "true" > 2.6.< / strong > Finalisation in Destructors< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/mem-replace.html" > < strong aria-hidden = "true" > 2.7.< / strong > mem::{take(_), replace(_)}< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/on-stack-dyn-dispatch.html" > < strong aria-hidden = "true" > 2.8.< / strong > On-Stack Dynamic Dispatch< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi/intro.html" > < strong aria-hidden = "true" > 2.9.< / strong > Foreign function interface (FFI)< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "idioms/ffi/errors.html" > < strong aria-hidden = "true" > 2.9.1.< / strong > Idiomatic Errors< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi/accepting-strings.html" > < strong aria-hidden = "true" > 2.9.2.< / strong > Accepting Strings< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi/passing-strings.html" > < strong aria-hidden = "true" > 2.9.3.< / strong > Passing Strings< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "idioms/option-iter.html" > < strong aria-hidden = "true" > 2.10.< / strong > Iterating over an Option< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/pass-var-to-closure.html" > < strong aria-hidden = "true" > 2.11.< / strong > Pass Variables to Closure< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/priv-extend.html" > < strong aria-hidden = "true" > 2.12.< / strong > Privacy For Extensibility< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/rustdoc-init.html" > < strong aria-hidden = "true" > 2.13.< / strong > Easy doc initialization< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/temporary-mutability.html" > < strong aria-hidden = "true" > 2.14.< / strong > Temporary mutability< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "patterns/index.html" > < strong aria-hidden = "true" > 3.< / strong > Design Patterns< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/intro.html" > < strong aria-hidden = "true" > 3.1.< / strong > Behavioural< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/command.html" > < strong aria-hidden = "true" > 3.1.1.< / strong > Command< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/interpreter.html" > < strong aria-hidden = "true" > 3.1.2.< / strong > Interpreter< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/newtype.html" > < strong aria-hidden = "true" > 3.1.3.< / strong > Newtype< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/RAII.html" > < strong aria-hidden = "true" > 3.1.4.< / strong > RAII Guards< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/strategy.html" > < strong aria-hidden = "true" > 3.1.5.< / strong > Strategy< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/behavioural/visitor.html" > < strong aria-hidden = "
2022-01-17 20:53:51 +00:00
< / div >
2021-01-01 11:28:10 +00:00
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar-hover-placeholder" > < / div >
< div id = "menu-bar" class = "menu-bar sticky bordered" >
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< button id = "theme-toggle" class = "icon-button" type = "button" title = "Change theme" aria-label = "Change theme" aria-haspopup = "true" aria-expanded = "false" aria-controls = "theme-list" >
< i class = "fa fa-paint-brush" > < / i >
< / button >
< ul id = "theme-list" class = "theme-popup" aria-label = "Themes" role = "menu" >
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "rust" > Rust (default)< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "coal" > Coal< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "navy" > Navy< / button > < / li >
< li role = "none" > < button role = "menuitem" class = "theme" id = "ayu" > Ayu< / button > < / li >
< / ul >
2022-01-17 20:53:51 +00:00
< button id = "search-toggle" class = "icon-button" type = "button" title = "Search. (Shortkey: s)" aria-label = "Toggle Searchbar" aria-expanded = "false" aria-keyshortcuts = "S" aria-controls = "searchbar" >
2021-01-01 11:28:10 +00:00
< i class = "fa fa-search" > < / i >
< / button >
2022-01-17 20:53:51 +00:00
< / div >
2021-01-01 11:28:10 +00:00
< h1 class = "menu-title" > Rust Design Patterns< / h1 >
< div class = "right-buttons" >
2022-01-17 20:53:51 +00:00
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
2021-01-01 11:28:10 +00:00
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
2022-01-17 20:53:51 +00:00
< a href = "https://github.com/rust-unofficial/patterns" title = "Git repository" aria-label = "Git repository" >
2021-01-01 11:28:10 +00:00
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< / div >
< / div >
2022-01-17 20:53:51 +00:00
< div id = "search-wrapper" class = "hidden" >
2021-01-01 11:28:10 +00:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2021-05-14 04:50:28 +00:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2021-01-01 11:28:10 +00:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
< script type = "text/javascript" >
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
< / script >
< div id = "content" class = "content" >
< main >
2021-03-02 21:12:13 +00:00
< h1 id = "introduction" > < a class = "header" href = "#introduction" > Introduction< / a > < / h1 >
< h2 id = "participation" > < a class = "header" href = "#participation" > Participation< / a > < / h2 >
2021-01-17 08:48:19 +00:00
< p > If you are interested in contributing to this book, check out the
2021-01-07 08:04:55 +00:00
< a href = "https://github.com/rust-unofficial/patterns/blob/master/CONTRIBUTING.md" > contribution guidelines< / a > .< / p >
2021-03-02 21:12:13 +00:00
< h2 id = "design-patterns" > < a class = "header" href = "#design-patterns" > Design patterns< / a > < / h2 >
2022-03-02 23:32:29 +00:00
< p > In software development, we often come across problems that share
similarities regardless of the environment they appear in. Although the
implementation details are crucial to solve the task at hand, we may
abstract from these particularities to find the common practices that
are generically applicable.< / p >
< p > Design patterns are a collection of reusable and tested solutions to
recurring problems in engineering. They make our software more modular,
maintainable, and extensible. Moreover, these patterns provide a common
2022-03-17 13:02:39 +00:00
language for developers, making them an excellent tool for effective
2022-03-02 23:32:29 +00:00
communication when problem-solving in teams.< / p >
2021-03-02 21:12:13 +00:00
< h2 id = "design-patterns-in-rust" > < a class = "header" href = "#design-patterns-in-rust" > Design patterns in Rust< / a > < / h2 >
2022-03-17 13:02:39 +00:00
< p > Rust is not object-oriented, and the combination of all its characteristics,
such as functional elements, a strong type system, and the borrow checker,
makes it unique.
Because of this, Rust design patterns vary with respect to other
traditional object-oriented programming languages.
That's why we decided to write this book. We hope you enjoy reading it!
The book is divided in three main chapters:< / p >
2021-01-20 15:19:00 +00:00
< ul >
2022-03-17 13:02:39 +00:00
< li > < a href = "./idioms/index.html" > Idioms< / a > : guidelines to follow when coding.
They are the social norms of the community.
You should break them only if you have a good reason for it.< / li >
< li > < a href = "./patterns/index.html" > Design patterns< / a > : methods to solve common problems
when coding.< / li >
< li > < a href = "./anti_patterns/index.html" > Anti-patterns< / a > : methods to solve common problems
when coding.
However, while design patterns give us benefits,
2021-01-20 15:19:00 +00:00
anti-patterns create more problems.< / li >
< / ul >
2021-01-01 11:28:10 +00:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2022-01-17 20:53:51 +00:00
< a rel = "next" href = "translations.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-01-01 11:28:10 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2022-01-17 20:53:51 +00:00
< a rel = "next" href = "translations.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
2021-01-01 11:28:10 +00:00
< i class = "fa fa-angle-right" > < / i >
< / a >
2022-01-17 20:53:51 +00:00
< / nav >
2021-01-01 11:28:10 +00:00
< / div >
2022-01-17 20:53:51 +00:00
< script type = "text/javascript" >
2021-01-01 11:28:10 +00:00
window.playground_copyable = true;
< / script >
2022-01-17 20:53:51 +00:00
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
2021-01-01 11:28:10 +00:00
< script src = "mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
