713 lines
50 KiB
HTML
713 lines
50 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Publishing a Crate to Crates.io - The Rust Programming Language</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff">
|
||
|
||
<link rel="icon" href="favicon-de23e50b.svg">
|
||
<link rel="shortcut icon" href="favicon-8114d1fc.png">
|
||
<link rel="stylesheet" href="css/variables-8adf115d.css">
|
||
<link rel="stylesheet" href="css/general-0392ca55.css">
|
||
<link rel="stylesheet" href="css/chrome-fc474251.css">
|
||
<link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="fonts/fonts-9644e21d.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" id="mdbook-highlight-css" href="highlight-493f70e1.css">
|
||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="tomorrow-night-4c0ae647.css">
|
||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="ayu-highlight-3fdfc3ac.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
<link rel="stylesheet" href="ferris-d33b75bf.css">
|
||
<link rel="stylesheet" href="theme/2018-edition-4e126c62.css">
|
||
<link rel="stylesheet" href="theme/semantic-notes-9b5766c0.css">
|
||
<link rel="stylesheet" href="theme/listing-cab26221.css">
|
||
|
||
|
||
<!-- Provide site root and default themes to javascript -->
|
||
<script>
|
||
const path_to_root = "";
|
||
const default_light_theme = "light";
|
||
const default_dark_theme = "navy";
|
||
window.path_to_searchindex_js = "searchindex-6a1da8cc.js";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="toc-0e4ce700.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="mdbook-help-container">
|
||
<div id="mdbook-help-popup">
|
||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
<div>
|
||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
<p>Press <kbd>?</kbd> to show this help</p>
|
||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="mdbook-body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
let theme = localStorage.getItem('mdbook-theme');
|
||
let 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>
|
||
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
let theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
let sidebar = null;
|
||
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
sidebar_toggle.checked = false;
|
||
}
|
||
if (sidebar === 'visible') {
|
||
sidebar_toggle.checked = true;
|
||
} else {
|
||
html.classList.remove('sidebar-visible');
|
||
}
|
||
</script>
|
||
|
||
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="toc.html"></iframe>
|
||
</noscript>
|
||
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||
</label>
|
||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||
</button>
|
||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||
</button>
|
||
</div>
|
||
|
||
<h1 class="menu-title">The Rust Programming Language</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/rust-lang/book" title="Git repository" aria-label="Git repository">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="mdbook-search-wrapper" class="hidden">
|
||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||
<div class="search-wrapper">
|
||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||
<div class="spinner-wrapper">
|
||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||
<ul id="mdbook-searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="mdbook-content" class="content">
|
||
<main>
|
||
<h2 id="publishing-a-crate-to-cratesio"><a class="header" href="#publishing-a-crate-to-cratesio">Publishing a Crate to Crates.io</a></h2>
|
||
<p>We’ve used packages from <a href="https://crates.io/">crates.io</a><!-- ignore --> as
|
||
dependencies of our project, but you can also share your code with other people
|
||
by publishing your own packages. The crate registry at
|
||
<a href="https://crates.io/">crates.io</a><!-- ignore --> distributes the source code of
|
||
your packages, so it primarily hosts code that is open source.</p>
|
||
<p>Rust and Cargo have features that make your published package easier for people
|
||
to find and use. We’ll talk about some of these features next and then explain
|
||
how to publish a package.</p>
|
||
<h3 id="making-useful-documentation-comments"><a class="header" href="#making-useful-documentation-comments">Making Useful Documentation Comments</a></h3>
|
||
<p>Accurately documenting your packages will help other users know how and when to
|
||
use them, so it’s worth investing the time to write documentation. In Chapter
|
||
3, we discussed how to comment Rust code using two slashes, <code>//</code>. Rust also has
|
||
a particular kind of comment for documentation, known conveniently as a
|
||
<em>documentation comment</em>, that will generate HTML documentation. The HTML
|
||
displays the contents of documentation comments for public API items intended
|
||
for programmers interested in knowing how to <em>use</em> your crate as opposed to how
|
||
your crate is <em>implemented</em>.</p>
|
||
<p>Documentation comments use three slashes, <code>///</code>, instead of two and support
|
||
Markdown notation for formatting the text. Place documentation comments just
|
||
before the item they’re documenting. Listing 14-1 shows documentation comments
|
||
for an <code>add_one</code> function in a crate named <code>my_crate</code>.</p>
|
||
<figure class="listing" id="listing-14-1">
|
||
<span class="file-name">Filename: src/lib.rs</span>
|
||
<pre><code class="language-rust ignore">/// Adds one to the number given.
|
||
///
|
||
/// # Examples
|
||
///
|
||
/// ```
|
||
/// let arg = 5;
|
||
/// let answer = my_crate::add_one(arg);
|
||
///
|
||
/// assert_eq!(6, answer);
|
||
/// ```
|
||
pub fn add_one(x: i32) -> i32 {
|
||
x + 1
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-14-1">Listing 14-1</a>: A documentation comment for a function</figcaption>
|
||
</figure>
|
||
<p>Here, we give a description of what the <code>add_one</code> function does, start a
|
||
section with the heading <code>Examples</code>, and then provide code that demonstrates
|
||
how to use the <code>add_one</code> function. We can generate the HTML documentation from
|
||
this documentation comment by running <code>cargo doc</code>. This command runs the
|
||
<code>rustdoc</code> tool distributed with Rust and puts the generated HTML documentation
|
||
in the <em>target/doc</em> directory.</p>
|
||
<p>For convenience, running <code>cargo doc --open</code> will build the HTML for your
|
||
current crate’s documentation (as well as the documentation for all of your
|
||
crate’s dependencies) and open the result in a web browser. Navigate to the
|
||
<code>add_one</code> function and you’ll see how the text in the documentation comments is
|
||
rendered, as shown in Figure 14-1.</p>
|
||
<img alt="Rendered HTML documentation for the `add_one` function of `my_crate`" src="img/trpl14-01.png" class="center" />
|
||
<p><span class="caption">Figure 14-1: The HTML documentation for the <code>add_one</code>
|
||
function</span></p>
|
||
<h4 id="commonly-used-sections"><a class="header" href="#commonly-used-sections">Commonly Used Sections</a></h4>
|
||
<p>We used the <code># Examples</code> Markdown heading in Listing 14-1 to create a section
|
||
in the HTML with the title “Examples.” Here are some other sections that crate
|
||
authors commonly use in their documentation:</p>
|
||
<ul>
|
||
<li><strong>Panics</strong>: These are the scenarios in which the function being documented
|
||
could panic. Callers of the function who don’t want their programs to panic
|
||
should make sure they don’t call the function in these situations.</li>
|
||
<li><strong>Errors</strong>: If the function returns a <code>Result</code>, describing the kinds of
|
||
errors that might occur and what conditions might cause those errors to be
|
||
returned can be helpful to callers so that they can write code to handle the
|
||
different kinds of errors in different ways.</li>
|
||
<li><strong>Safety</strong>: If the function is <code>unsafe</code> to call (we discuss unsafety in
|
||
Chapter 20), there should be a section explaining why the function is unsafe
|
||
and covering the invariants that the function expects callers to uphold.</li>
|
||
</ul>
|
||
<p>Most documentation comments don’t need all of these sections, but this is a
|
||
good checklist to remind you of the aspects of your code users will be
|
||
interested in knowing about.</p>
|
||
<h4 id="documentation-comments-as-tests"><a class="header" href="#documentation-comments-as-tests">Documentation Comments as Tests</a></h4>
|
||
<p>Adding example code blocks in your documentation comments can help demonstrate
|
||
how to use your library and has an additional bonus: Running <code>cargo test</code> will
|
||
run the code examples in your documentation as tests! Nothing is better than
|
||
documentation with examples. But nothing is worse than examples that don’t work
|
||
because the code has changed since the documentation was written. If we run
|
||
<code>cargo test</code> with the documentation for the <code>add_one</code> function from Listing
|
||
14-1, we will see a section in the test results that looks like this:</p>
|
||
<!-- manual-regeneration
|
||
cd listings/ch14-more-about-cargo/listing-14-01/
|
||
cargo test
|
||
copy just the doc-tests section below
|
||
-->
|
||
<pre><code class="language-text"> Doc-tests my_crate
|
||
|
||
running 1 test
|
||
test src/lib.rs - add_one (line 5) ... ok
|
||
|
||
test result: ok. 1 passed; 0 failed; 0 ignored; 0 measured; 0 filtered out; finished in 0.27s
|
||
</code></pre>
|
||
<p>Now, if we change either the function or the example so that the <code>assert_eq!</code>
|
||
in the example panics, and run <code>cargo test</code> again, we’ll see that the doc tests
|
||
catch that the example and the code are out of sync with each other!</p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="commenting-contained-items"></a></p>
|
||
<h4 id="contained-item-comments"><a class="header" href="#contained-item-comments">Contained Item Comments</a></h4>
|
||
<p>The style of doc comment <code>//!</code> adds documentation to the item that <em>contains</em>
|
||
the comments rather than to the items <em>following</em> the comments. We typically
|
||
use these doc comments inside the crate root file (<em>src/lib.rs</em> by convention)
|
||
or inside a module to document the crate or the module as a whole.</p>
|
||
<p>For example, to add documentation that describes the purpose of the <code>my_crate</code>
|
||
crate that contains the <code>add_one</code> function, we add documentation comments that
|
||
start with <code>//!</code> to the beginning of the <em>src/lib.rs</em> file, as shown in Listing
|
||
14-2.</p>
|
||
<figure class="listing" id="listing-14-2">
|
||
<span class="file-name">Filename: src/lib.rs</span>
|
||
<pre><code class="language-rust ignore">//! # My Crate
|
||
//!
|
||
//! `my_crate` is a collection of utilities to make performing certain
|
||
//! calculations more convenient.
|
||
|
||
/// Adds one to the number given.
|
||
// --snip--
|
||
<span class="boring">///
|
||
</span><span class="boring">/// # Examples
|
||
</span><span class="boring">///
|
||
</span><span class="boring">/// ```
|
||
</span><span class="boring">/// let arg = 5;
|
||
</span><span class="boring">/// let answer = my_crate::add_one(arg);
|
||
</span><span class="boring">///
|
||
</span><span class="boring">/// assert_eq!(6, answer);
|
||
</span><span class="boring">/// ```
|
||
</span><span class="boring">pub fn add_one(x: i32) -> i32 {
|
||
</span><span class="boring"> x + 1
|
||
</span><span class="boring">}</span></code></pre>
|
||
<figcaption><a href="#listing-14-2">Listing 14-2</a>: The documentation for the <code>my_crate</code> crate as a whole</figcaption>
|
||
</figure>
|
||
<p>Notice there isn’t any code after the last line that begins with <code>//!</code>. Because
|
||
we started the comments with <code>//!</code> instead of <code>///</code>, we’re documenting the item
|
||
that contains this comment rather than an item that follows this comment. In
|
||
this case, that item is the <em>src/lib.rs</em> file, which is the crate root. These
|
||
comments describe the entire crate.</p>
|
||
<p>When we run <code>cargo doc --open</code>, these comments will display on the front page
|
||
of the documentation for <code>my_crate</code> above the list of public items in the
|
||
crate, as shown in Figure 14-2.</p>
|
||
<p>Documentation comments within items are useful for describing crates and
|
||
modules especially. Use them to explain the overall purpose of the container to
|
||
help your users understand the crate’s organization.</p>
|
||
<img alt="Rendered HTML documentation with a comment for the crate as a whole" src="img/trpl14-02.png" class="center" />
|
||
<p><span class="caption">Figure 14-2: The rendered documentation for <code>my_crate</code>,
|
||
including the comment describing the crate as a whole</span></p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="exporting-a-convenient-public-api-with-pub-use"></a></p>
|
||
<h3 id="exporting-a-convenient-public-api"><a class="header" href="#exporting-a-convenient-public-api">Exporting a Convenient Public API</a></h3>
|
||
<p>The structure of your public API is a major consideration when publishing a
|
||
crate. People who use your crate are less familiar with the structure than you
|
||
are and might have difficulty finding the pieces they want to use if your crate
|
||
has a large module hierarchy.</p>
|
||
<p>In Chapter 7, we covered how to make items public using the <code>pub</code> keyword, and
|
||
how to bring items into a scope with the <code>use</code> keyword. However, the structure
|
||
that makes sense to you while you’re developing a crate might not be very
|
||
convenient for your users. You might want to organize your structs in a
|
||
hierarchy containing multiple levels, but then people who want to use a type
|
||
you’ve defined deep in the hierarchy might have trouble finding out that type
|
||
exists. They might also be annoyed at having to enter <code>use my_crate::some_module::another_module::UsefulType;</code> rather than <code>use my_crate::UsefulType;</code>.</p>
|
||
<p>The good news is that if the structure <em>isn’t</em> convenient for others to use
|
||
from another library, you don’t have to rearrange your internal organization:
|
||
Instead, you can re-export items to make a public structure that’s different
|
||
from your private structure by using <code>pub use</code>. <em>Re-exporting</em> takes a public
|
||
item in one location and makes it public in another location, as if it were
|
||
defined in the other location instead.</p>
|
||
<p>For example, say we made a library named <code>art</code> for modeling artistic concepts.
|
||
Within this library are two modules: a <code>kinds</code> module containing two enums
|
||
named <code>PrimaryColor</code> and <code>SecondaryColor</code> and a <code>utils</code> module containing a
|
||
function named <code>mix</code>, as shown in Listing 14-3.</p>
|
||
<figure class="listing" id="listing-14-3">
|
||
<span class="file-name">Filename: src/lib.rs</span>
|
||
<pre><code class="language-rust noplayground test_harness">//! # Art
|
||
//!
|
||
//! A library for modeling artistic concepts.
|
||
|
||
pub mod kinds {
|
||
/// The primary colors according to the RYB color model.
|
||
pub enum PrimaryColor {
|
||
Red,
|
||
Yellow,
|
||
Blue,
|
||
}
|
||
|
||
/// The secondary colors according to the RYB color model.
|
||
pub enum SecondaryColor {
|
||
Orange,
|
||
Green,
|
||
Purple,
|
||
}
|
||
}
|
||
|
||
pub mod utils {
|
||
use crate::kinds::*;
|
||
|
||
/// Combines two primary colors in equal amounts to create
|
||
/// a secondary color.
|
||
pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
|
||
// --snip--
|
||
<span class="boring"> unimplemented!();
|
||
</span> }
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-14-3">Listing 14-3</a>: An <code>art</code> library with items organized into <code>kinds</code> and <code>utils</code> modules</figcaption>
|
||
</figure>
|
||
<p>Figure 14-3 shows what the front page of the documentation for this crate
|
||
generated by <code>cargo doc</code> would look like.</p>
|
||
<img alt="Rendered documentation for the `art` crate that lists the `kinds` and `utils` modules" src="img/trpl14-03.png" class="center" />
|
||
<p><span class="caption">Figure 14-3: The front page of the documentation for <code>art</code>
|
||
that lists the <code>kinds</code> and <code>utils</code> modules</span></p>
|
||
<p>Note that the <code>PrimaryColor</code> and <code>SecondaryColor</code> types aren’t listed on the
|
||
front page, nor is the <code>mix</code> function. We have to click <code>kinds</code> and <code>utils</code> to
|
||
see them.</p>
|
||
<p>Another crate that depends on this library would need <code>use</code> statements that
|
||
bring the items from <code>art</code> into scope, specifying the module structure that’s
|
||
currently defined. Listing 14-4 shows an example of a crate that uses the
|
||
<code>PrimaryColor</code> and <code>mix</code> items from the <code>art</code> crate.</p>
|
||
<figure class="listing" id="listing-14-4">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre><code class="language-rust ignore">use art::kinds::PrimaryColor;
|
||
use art::utils::mix;
|
||
|
||
fn main() {
|
||
let red = PrimaryColor::Red;
|
||
let yellow = PrimaryColor::Yellow;
|
||
mix(red, yellow);
|
||
}</code></pre>
|
||
<figcaption><a href="#listing-14-4">Listing 14-4</a>: A crate using the <code>art</code> crate’s items with its internal structure exported</figcaption>
|
||
</figure>
|
||
<p>The author of the code in Listing 14-4, which uses the <code>art</code> crate, had to
|
||
figure out that <code>PrimaryColor</code> is in the <code>kinds</code> module and <code>mix</code> is in the
|
||
<code>utils</code> module. The module structure of the <code>art</code> crate is more relevant to
|
||
developers working on the <code>art</code> crate than to those using it. The internal
|
||
structure doesn’t contain any useful information for someone trying to
|
||
understand how to use the <code>art</code> crate, but rather causes confusion because
|
||
developers who use it have to figure out where to look, and must specify the
|
||
module names in the <code>use</code> statements.</p>
|
||
<p>To remove the internal organization from the public API, we can modify the
|
||
<code>art</code> crate code in Listing 14-3 to add <code>pub use</code> statements to re-export the
|
||
items at the top level, as shown in Listing 14-5.</p>
|
||
<figure class="listing" id="listing-14-5">
|
||
<span class="file-name">Filename: src/lib.rs</span>
|
||
<pre><code class="language-rust ignore">//! # Art
|
||
//!
|
||
//! A library for modeling artistic concepts.
|
||
|
||
pub use self::kinds::PrimaryColor;
|
||
pub use self::kinds::SecondaryColor;
|
||
pub use self::utils::mix;
|
||
|
||
pub mod kinds {
|
||
// --snip--
|
||
<span class="boring"> /// The primary colors according to the RYB color model.
|
||
</span><span class="boring"> pub enum PrimaryColor {
|
||
</span><span class="boring"> Red,
|
||
</span><span class="boring"> Yellow,
|
||
</span><span class="boring"> Blue,
|
||
</span><span class="boring"> }
|
||
</span><span class="boring">
|
||
</span><span class="boring"> /// The secondary colors according to the RYB color model.
|
||
</span><span class="boring"> pub enum SecondaryColor {
|
||
</span><span class="boring"> Orange,
|
||
</span><span class="boring"> Green,
|
||
</span><span class="boring"> Purple,
|
||
</span><span class="boring"> }
|
||
</span>}
|
||
|
||
pub mod utils {
|
||
// --snip--
|
||
<span class="boring"> use crate::kinds::*;
|
||
</span><span class="boring">
|
||
</span><span class="boring"> /// Combines two primary colors in equal amounts to create
|
||
</span><span class="boring"> /// a secondary color.
|
||
</span><span class="boring"> pub fn mix(c1: PrimaryColor, c2: PrimaryColor) -> SecondaryColor {
|
||
</span><span class="boring"> SecondaryColor::Orange
|
||
</span><span class="boring"> }
|
||
</span>}</code></pre>
|
||
<figcaption><a href="#listing-14-5">Listing 14-5</a>: Adding <code>pub use</code> statements to re-export items</figcaption>
|
||
</figure>
|
||
<p>The API documentation that <code>cargo doc</code> generates for this crate will now list
|
||
and link re-exports on the front page, as shown in Figure 14-4, making the
|
||
<code>PrimaryColor</code> and <code>SecondaryColor</code> types and the <code>mix</code> function easier to find.</p>
|
||
<img alt="Rendered documentation for the `art` crate with the re-exports on the front page" src="img/trpl14-04.png" class="center" />
|
||
<p><span class="caption">Figure 14-4: The front page of the documentation for <code>art</code>
|
||
that lists the re-exports</span></p>
|
||
<p>The <code>art</code> crate users can still see and use the internal structure from Listing
|
||
14-3 as demonstrated in Listing 14-4, or they can use the more convenient
|
||
structure in Listing 14-5, as shown in Listing 14-6.</p>
|
||
<figure class="listing" id="listing-14-6">
|
||
<span class="file-name">Filename: src/main.rs</span>
|
||
<pre><code class="language-rust ignore">use art::PrimaryColor;
|
||
use art::mix;
|
||
|
||
fn main() {
|
||
// --snip--
|
||
<span class="boring"> let red = PrimaryColor::Red;
|
||
</span><span class="boring"> let yellow = PrimaryColor::Yellow;
|
||
</span><span class="boring"> mix(red, yellow);
|
||
</span>}</code></pre>
|
||
<figcaption><a href="#listing-14-6">Listing 14-6</a>: A program using the re-exported items from the <code>art</code> crate</figcaption>
|
||
</figure>
|
||
<p>In cases where there are many nested modules, re-exporting the types at the top
|
||
level with <code>pub use</code> can make a significant difference in the experience of
|
||
people who use the crate. Another common use of <code>pub use</code> is to re-export
|
||
definitions of a dependency in the current crate to make that crate’s
|
||
definitions part of your crate’s public API.</p>
|
||
<p>Creating a useful public API structure is more an art than a science, and you
|
||
can iterate to find the API that works best for your users. Choosing <code>pub use</code>
|
||
gives you flexibility in how you structure your crate internally and decouples
|
||
that internal structure from what you present to your users. Look at some of
|
||
the code of crates you’ve installed to see if their internal structure differs
|
||
from their public API.</p>
|
||
<h3 id="setting-up-a-cratesio-account"><a class="header" href="#setting-up-a-cratesio-account">Setting Up a Crates.io Account</a></h3>
|
||
<p>Before you can publish any crates, you need to create an account on
|
||
<a href="https://crates.io/">crates.io</a><!-- ignore --> and get an API token. To do so,
|
||
visit the home page at <a href="https://crates.io/">crates.io</a><!-- ignore --> and log
|
||
in via a GitHub account. (The GitHub account is currently a requirement, but
|
||
the site might support other ways of creating an account in the future.) Once
|
||
you’re logged in, visit your account settings at
|
||
<a href="https://crates.io/me/">https://crates.io/me/</a><!-- ignore --> and retrieve your
|
||
API key. Then, run the <code>cargo login</code> command and paste your API key when prompted, like this:</p>
|
||
<pre><code class="language-console">$ cargo login
|
||
abcdefghijklmnopqrstuvwxyz012345
|
||
</code></pre>
|
||
<p>This command will inform Cargo of your API token and store it locally in
|
||
<em>~/.cargo/credentials.toml</em>. Note that this token is a secret: Do not share
|
||
it with anyone else. If you do share it with anyone for any reason, you should
|
||
revoke it and generate a new token on <a href="https://crates.io/">crates.io</a><!-- ignore
|
||
-->.</p>
|
||
<h3 id="adding-metadata-to-a-new-crate"><a class="header" href="#adding-metadata-to-a-new-crate">Adding Metadata to a New Crate</a></h3>
|
||
<p>Let’s say you have a crate you want to publish. Before publishing, you’ll need
|
||
to add some metadata in the <code>[package]</code> section of the crate’s <em>Cargo.toml</em>
|
||
file.</p>
|
||
<p>Your crate will need a unique name. While you’re working on a crate locally,
|
||
you can name a crate whatever you’d like. However, crate names on
|
||
<a href="https://crates.io/">crates.io</a><!-- ignore --> are allocated on a first-come,
|
||
first-served basis. Once a crate name is taken, no one else can publish a crate
|
||
with that name. Before attempting to publish a crate, search for the name you
|
||
want to use. If the name has been used, you will need to find another name and
|
||
edit the <code>name</code> field in the <em>Cargo.toml</em> file under the <code>[package]</code> section to
|
||
use the new name for publishing, like so:</p>
|
||
<p><span class="filename">Filename: Cargo.toml</span></p>
|
||
<pre><code class="language-toml">[package]
|
||
name = "guessing_game"
|
||
</code></pre>
|
||
<p>Even if you’ve chosen a unique name, when you run <code>cargo publish</code> to publish
|
||
the crate at this point, you’ll get a warning and then an error:</p>
|
||
<!-- manual-regeneration
|
||
Create a new package with an unregistered name, making no further modifications
|
||
to the generated package, so it is missing the description and license fields.
|
||
cargo publish
|
||
copy just the relevant lines below
|
||
-->
|
||
<pre><code class="language-console">$ cargo publish
|
||
Updating crates.io index
|
||
warning: manifest has no description, license, license-file, documentation, homepage or repository.
|
||
See https://doc.rust-lang.org/cargo/reference/manifest.html#package-metadata for more info.
|
||
--snip--
|
||
error: failed to publish to registry at https://crates.io
|
||
|
||
Caused by:
|
||
the remote server responded with an error (status 400 Bad Request): missing or empty metadata fields: description, license. Please see https://doc.rust-lang.org/cargo/reference/manifest.html for more information on configuring these fields
|
||
</code></pre>
|
||
<p>This results in an error because you’re missing some crucial information: A
|
||
description and license are required so that people will know what your crate
|
||
does and under what terms they can use it. In <em>Cargo.toml</em>, add a description
|
||
that’s just a sentence or two, because it will appear with your crate in search
|
||
results. For the <code>license</code> field, you need to give a <em>license identifier
|
||
value</em>. The <a href="https://spdx.org/licenses/">Linux Foundation’s Software Package Data Exchange (SPDX)</a>
|
||
lists the identifiers you can use for this value. For example, to specify that
|
||
you’ve licensed your crate using the MIT License, add the <code>MIT</code> identifier:</p>
|
||
<p><span class="filename">Filename: Cargo.toml</span></p>
|
||
<pre><code class="language-toml">[package]
|
||
name = "guessing_game"
|
||
license = "MIT"
|
||
</code></pre>
|
||
<p>If you want to use a license that doesn’t appear in the SPDX, you need to place
|
||
the text of that license in a file, include the file in your project, and then
|
||
use <code>license-file</code> to specify the name of that file instead of using the
|
||
<code>license</code> key.</p>
|
||
<p>Guidance on which license is appropriate for your project is beyond the scope
|
||
of this book. Many people in the Rust community license their projects in the
|
||
same way as Rust by using a dual license of <code>MIT OR Apache-2.0</code>. This practice
|
||
demonstrates that you can also specify multiple license identifiers separated
|
||
by <code>OR</code> to have multiple licenses for your project.</p>
|
||
<p>With a unique name, the version, your description, and a license added, the
|
||
<em>Cargo.toml</em> file for a project that is ready to publish might look like this:</p>
|
||
<p><span class="filename">Filename: Cargo.toml</span></p>
|
||
<pre><code class="language-toml">[package]
|
||
name = "guessing_game"
|
||
version = "0.1.0"
|
||
edition = "2024"
|
||
description = "A fun game where you guess what number the computer has chosen."
|
||
license = "MIT OR Apache-2.0"
|
||
|
||
[dependencies]
|
||
</code></pre>
|
||
<p><a href="https://doc.rust-lang.org/cargo/">Cargo’s documentation</a> describes other
|
||
metadata you can specify to ensure that others can discover and use your crate
|
||
more easily.</p>
|
||
<h3 id="publishing-to-cratesio"><a class="header" href="#publishing-to-cratesio">Publishing to Crates.io</a></h3>
|
||
<p>Now that you’ve created an account, saved your API token, chosen a name for
|
||
your crate, and specified the required metadata, you’re ready to publish!
|
||
Publishing a crate uploads a specific version to
|
||
<a href="https://crates.io/">crates.io</a><!-- ignore --> for others to use.</p>
|
||
<p>Be careful, because a publish is <em>permanent</em>. The version can never be
|
||
overwritten, and the code cannot be deleted except in certain circumstances.
|
||
One major goal of Crates.io is to act as a permanent archive of code so that
|
||
builds of all projects that depend on crates from
|
||
<a href="https://crates.io/">crates.io</a><!-- ignore --> will continue to work. Allowing
|
||
version deletions would make fulfilling that goal impossible. However, there is
|
||
no limit to the number of crate versions you can publish.</p>
|
||
<p>Run the <code>cargo publish</code> command again. It should succeed now:</p>
|
||
<!-- manual-regeneration
|
||
go to some valid crate, publish a new version
|
||
cargo publish
|
||
copy just the relevant lines below
|
||
-->
|
||
<pre><code class="language-console">$ cargo publish
|
||
Updating crates.io index
|
||
Packaging guessing_game v0.1.0 (file:///projects/guessing_game)
|
||
Packaged 6 files, 1.2KiB (895.0B compressed)
|
||
Verifying guessing_game v0.1.0 (file:///projects/guessing_game)
|
||
Compiling guessing_game v0.1.0
|
||
(file:///projects/guessing_game/target/package/guessing_game-0.1.0)
|
||
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.19s
|
||
Uploading guessing_game v0.1.0 (file:///projects/guessing_game)
|
||
Uploaded guessing_game v0.1.0 to registry `crates-io`
|
||
note: waiting for `guessing_game v0.1.0` to be available at registry
|
||
`crates-io`.
|
||
You may press ctrl-c to skip waiting; the crate should be available shortly.
|
||
Published guessing_game v0.1.0 at registry `crates-io`
|
||
</code></pre>
|
||
<p>Congratulations! You’ve now shared your code with the Rust community, and
|
||
anyone can easily add your crate as a dependency of their project.</p>
|
||
<h3 id="publishing-a-new-version-of-an-existing-crate"><a class="header" href="#publishing-a-new-version-of-an-existing-crate">Publishing a New Version of an Existing Crate</a></h3>
|
||
<p>When you’ve made changes to your crate and are ready to release a new version,
|
||
you change the <code>version</code> value specified in your <em>Cargo.toml</em> file and
|
||
republish. Use the <a href="https://semver.org/">Semantic Versioning rules</a> to decide what an
|
||
appropriate next version number is, based on the kinds of changes you’ve made.
|
||
Then, run <code>cargo publish</code> to upload the new version.</p>
|
||
<!-- Old headings. Do not remove or links may break. -->
|
||
<p><a id="removing-versions-from-cratesio-with-cargo-yank"></a>
|
||
<a id="deprecating-versions-from-cratesio-with-cargo-yank"></a></p>
|
||
<h3 id="deprecating-versions-from-cratesio"><a class="header" href="#deprecating-versions-from-cratesio">Deprecating Versions from Crates.io</a></h3>
|
||
<p>Although you can’t remove previous versions of a crate, you can prevent any
|
||
future projects from adding them as a new dependency. This is useful when a
|
||
crate version is broken for one reason or another. In such situations, Cargo
|
||
supports yanking a crate version.</p>
|
||
<p><em>Yanking</em> a version prevents new projects from depending on that version while
|
||
allowing all existing projects that depend on it to continue. Essentially, a
|
||
yank means that all projects with a <em>Cargo.lock</em> will not break, and any future
|
||
<em>Cargo.lock</em> files generated will not use the yanked version.</p>
|
||
<p>To yank a version of a crate, in the directory of the crate that you’ve
|
||
previously published, run <code>cargo yank</code> and specify which version you want to
|
||
yank. For example, if we’ve published a crate named <code>guessing_game</code> version
|
||
1.0.1 and we want to yank it, then we’d run the following in the project
|
||
directory for <code>guessing_game</code>:</p>
|
||
<!-- manual-regeneration:
|
||
cargo yank carol-test --version 2.1.0
|
||
cargo yank carol-test --version 2.1.0 --undo
|
||
-->
|
||
<pre><code class="language-console">$ cargo yank --vers 1.0.1
|
||
Updating crates.io index
|
||
Yank guessing_game@1.0.1
|
||
</code></pre>
|
||
<p>By adding <code>--undo</code> to the command, you can also undo a yank and allow projects
|
||
to start depending on a version again:</p>
|
||
<pre><code class="language-console">$ cargo yank --vers 1.0.1 --undo
|
||
Updating crates.io index
|
||
Unyank guessing_game@1.0.1
|
||
</code></pre>
|
||
<p>A yank <em>does not</em> delete any code. It cannot, for example, delete accidentally
|
||
uploaded secrets. If that happens, you must reset those secrets immediately.</p>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="ch14-01-release-profiles.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="ch14-03-cargo-workspaces.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="ch14-01-release-profiles.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="ch14-03-cargo-workspaces.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="elasticlunr-ef4e11c1.min.js"></script>
|
||
<script src="mark-09e88c2c.min.js"></script>
|
||
<script src="searcher-09f2665d.js"></script>
|
||
|
||
<script src="clipboard-1626706a.min.js"></script>
|
||
<script src="highlight-abc7f01d.js"></script>
|
||
<script src="book-c22b7243.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
<script src="ferris-2317480c.js"></script>
|
||
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|