2021-01-05 16:14:14 +00:00
<!DOCTYPE HTML>
< html lang = "en" class = "sidebar-visible no-js rust" >
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
< title > Contributing - 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" / >
< link rel = "icon" href = "favicon.svg" >
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
< link rel = "stylesheet" href = "css/print.css" media = "print" >
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
< link rel = "stylesheet" href = "fonts/fonts.css" >
<!-- 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 -->
< / head >
< 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" >
2021-01-06 14:03:34 +00:00
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "intro.html" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "CONTRIBUTING.html" class = "active" > < strong aria-hidden = "true" > 2.< / strong > Contributing< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/index.html" > < strong aria-hidden = "true" > 3.< / strong > Idioms< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "idioms/coercion-arguments.html" > < strong aria-hidden = "true" > 3.1.< / strong > Use borrowed types for arguments< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/concat-format.html" > < strong aria-hidden = "true" > 3.2.< / strong > Concatenating Strings with format!< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ctor.html" > < strong aria-hidden = "true" > 3.3.< / strong > Constructor< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/default.html" > < strong aria-hidden = "true" > 3.4.< / strong > The Default Trait< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/deref.html" > < strong aria-hidden = "true" > 3.5.< / strong > Collections Are Smart Pointers< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/dtor-finally.html" > < strong aria-hidden = "true" > 3.6.< / strong > Finalisation in Destructors< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/mem-replace.html" > < strong aria-hidden = "true" > 3.7.< / strong > mem::replace(_)< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/on-stack-dyn-dispatch.html" > < strong aria-hidden = "true" > 3.8.< / strong > On-Stack Dynamic Dispatch< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi-intro.html" > < strong aria-hidden = "true" > 3.9.< / strong > Foreign function interface usage< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "idioms/ffi-errors.html" > < strong aria-hidden = "true" > 3.9.1.< / strong > Idiomatic Errors< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi-accepting-strings.html" > < strong aria-hidden = "true" > 3.9.2.< / strong > Accepting Strings< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/ffi-passing-strings.html" > < strong aria-hidden = "true" > 3.9.3.< / strong > Passing Strings< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "idioms/option-iter.html" > < strong aria-hidden = "true" > 3.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" > 3.11.< / strong > Pass Variables to Closure< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/priv-extend.html" > < strong aria-hidden = "true" > 3.12.< / strong > Privacy For Extensibility< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/rustdoc-init.html" > < strong aria-hidden = "true" > 3.13.< / strong > Easy doc initialization< / a > < / li > < li class = "chapter-item expanded " > < a href = "idioms/temporary-mutability.html" > < strong aria-hidden = "true" > 3.14.< / strong > Temporary mutability< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "patterns/index.html" > < strong aria-hidden = "true" > 4.< / strong > Design Patterns< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "patterns/builder.html" > < strong aria-hidden = "true" > 4.1.< / strong > Builder< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/compose-structs.html" > < strong aria-hidden = "true" > 4.2.< / strong > Compose Structs< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/entry.html" > < strong aria-hidden = "true" > 4.3.< / strong > Entry API< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/ffi-intro.html" > < strong aria-hidden = "true" > 4.4.< / strong > Foreign function interface usage< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "patterns/ffi-export.html" > < strong aria-hidden = "true" > 4.4.1.< / strong > Object-Based APIs< / a > < / li > < li class = "chapter-item expanded " > < a href = "patterns/ffi-wrappers.html" > < strong aria-hidden = "true" > 4.4.2.< / strong > Type Consolidation into Wrappers< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "patterns/fold.html" > < strong aria-hidden = "true" > 4.5.< / strong > Fold< / a > < / li > < li class = "chapter-item
2021-01-05 16:14:14 +00:00
< / div >
< 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 >
< 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" >
< i class = "fa fa-search" > < / i >
< / button >
< / div >
< h1 class = "menu-title" > Rust Design Patterns< / h1 >
< div class = "right-buttons" >
< a href = "print.html" title = "Print this book" aria-label = "Print this book" >
< i id = "print-button" class = "fa fa-print" > < / i >
< / a >
< a href = "https://github.com/rust-unofficial/patterns" title = "Git repository" aria-label = "Git repository" >
< i id = "git-repository-button" class = "fa fa-github" > < / i >
< / a >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
< / 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 >
< h1 > < a class = "header" href = "#contributing" id = "contributing" > Contributing< / a > < / h1 >
2021-01-05 16:19:18 +00:00
< h2 > < a class = "header" href = "#introduction" id = "introduction" > Introduction< / a > < / h2 >
< p > This book is a catalogue of Rust programming techniques, (anti-)patterns, idioms and other explanations.
It is a compilation of collective (sometimes implicit) knowledge as well as experiences that have emerged through collaborative work.< / p >
< p > The patterns described here are < strong > not rules< / strong > , but should be taken as guidelines for writing idiomatic code in Rust.
We are collecting Rust patterns in this book so people can learn the tradeoffs between Rust idioms and use them properly in their own code.< / p >
< p > If you want to be part of this effort here are some ways you can participate:< / p >
2021-01-05 16:14:14 +00:00
< h2 > < a class = "header" href = "#discussion-board" id = "discussion-board" > Discussion board< / a > < / h2 >
< p > If you have a question or an idea regarding certain content but you want to have feedback of fellow community members
and you think it may not be appropriate to file an issue open a discussion in our < a href = "https://github.com/rust-unofficial/patterns/discussions" > discussion board< / a > .< / p >
< h2 > < a class = "header" href = "#writing-a-new-article" id = "writing-a-new-article" > Writing a new article< / a > < / h2 >
2021-01-06 12:55:29 +00:00
< p > Before writing a new article please check in one of the following resources if there is an existing discussion or if someone is already working on that topic:< / p >
< ul >
< li > < a href = "https://github.com/rust-unofficial/patterns/issues/116" > Umbrella issue< / a > ,< / li >
< li > < a href = "https://github.com/rust-unofficial/patterns/issues" > All issues< / a > ,< / li >
< li > < a href = "https://github.com/rust-unofficial/patterns/pulls" > Pull Requests< / a > < / li >
< / ul >
2021-01-05 16:14:14 +00:00
< p > If you don't find an issue regarding your topic and you are sure it is not more feasible to open a thread in the < a href = "https://github.com/rust-unofficial/patterns/discussions" > discussion board< / a >
please open a new issue, so we can discuss about the ideas and future content of the article together and maybe
give some feedback/input on it.< / p >
< p > When writing a new article it's recommended to copy the < a href = "https://github.com/rust-unofficial/patterns/blob/master/template.md" > pattern template< / a > into the
appropriate directory and start editing it. You may not want to fill out every section and remove it or you might want to add extra sections.< / p >
< p > Consider writing your article in a way that has a low barrier of entry so also < a href = "https://github.com/rust-lang/rustlings" > Rustlings< / a > can follow
and understand the thought process behind it. So we can encourage people to use these patterns early on.< / p >
< p > We encourage you to write idiomatic Rust code that builds in the < a href = "https://play.rust-lang.org/" > playground< / a > .< / p >
< p > If you use links to blogposts or in general content that is not to be sure existing in a few years (e.g. pdfs) please take a snapshot
with the < a href = "https://web.archive.org/" > Wayback Machine< / a > and use the link to that snapshot in your article.< / p >
< p > Don't forget to add your new article to the < code > SUMMARY.md< / code > to let it be rendered to the book.< / p >
< p > Please make < code > Draft Pull requests< / code > early so we can follow your progress and can give early feedback (see the following section).< / p >
2021-01-06 12:15:52 +00:00
< h2 > < a class = "header" href = "#check-the-article-locally" id = "check-the-article-locally" > Check the article locally< / a > < / h2 >
< p > Before submitting the PR launch the commands < code > mdbook build< / code > to make sure that the book builds and < code > mdbook test< / code > to make sure that
code examples are correct.< / p >
< h3 > < a class = "header" href = "#markdown-lint" id = "markdown-lint" > Markdown lint< / a > < / h3 >
< p > To make sure the files comply with our Markdown style we use < a href = "https://github.com/igorshubovych/markdownlint-cli" > markdownlint-cli< / a > .
To spare you some manual work to get through the CI test you can use the following commands to automatically fix most of the emerging problems when writing Markdown files.< / p >
< ul >
< li >
< p > Install:< / p >
< pre > < code class = "language-sh" > npm install -g markdownlint-cli
< / code > < / pre >
< / li >
< li >
< p > Check all markdown files:< / p >
< ul >
< li > unix: < code > markdownlint '**/*.md'< / code > < / li >
< li > windows: < code > markdownlint **/*.md< / code > < / li >
< / ul >
< / li >
< li >
< p > Automatically fix basic errors:< / p >
< ul >
< li > unix: < code > markdownlint -f '**/*.md'< / code > < / li >
< li > windows: < code > markdownlint -f **/*.md< / code > < / li >
< / ul >
< / li >
< / ul >
2021-01-05 16:14:14 +00:00
< h2 > < a class = "header" href = "#creating-a-pull-request" id = "creating-a-pull-request" > Creating a Pull Request< / a > < / h2 >
< p > " Release early and often!" also applies to pull requests!< / p >
< p > Once your article has some visible work, create a < code > [WIP]< / code > draft pull request and give it a description of what you did or want to do.
Early reviews of the community are not meant as an offense but to give feedback.< / p >
< p > A good principle: " Work together, share ideas, teach others." < / p >
< h3 > < a class = "header" href = "#important-note" id = "important-note" > Important Note< / a > < / h3 >
2021-01-06 10:06:22 +00:00
< p > Please < strong > don't force push< / strong > commits in your branch, in order to keep commit history and make it easier for us to see changes between reviews.< / p >
2021-01-05 16:14:14 +00:00
< p > Make sure to < code > Allow edits of maintainers< / code > (under the text box) in the PR so people can actually collaborate on things or fix smaller issues themselves.< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "intro.html" class = "mobile-nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "idioms/index.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< 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" >
< a rel = "prev" href = "intro.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a rel = "next" href = "idioms/index.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
< / nav >
< / div >
< script type = "text/javascript" >
window.playground_copyable = true;
< / script >
< script src = "elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< 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 >
