mirror of
https://github.com/sunface/rust-by-practice.git
synced 2025-06-23 12:39:42 +00:00
321 lines
14 KiB
HTML
321 lines
14 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Package and Crate - Rust By Practice</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Learn Rust with Example, Exercise and real Practice, written with ❤️ by https://course.rs team">
|
|
<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" id="highlight-css" href="../highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
<link rel="stylesheet" href="../theme/style1.css">
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "../";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "navy";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="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="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("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 = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="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="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</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">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<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="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</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 By Practice</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/sunface/rust-by-practice" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/sunface/rust-by-practice/edit/master/en/src/crate-module/crate.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="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>
|
|
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 id="package-and-crate"><a class="header" href="#package-and-crate">Package and Crate</a></h1>
|
|
<p>A package is a project which you create with Cargo (in most cases), so it contains a <code>Cargo.toml</code> file in it.</p>
|
|
<ol>
|
|
<li>🌟 Create a package with below layout:</li>
|
|
</ol>
|
|
<pre><code class="language-shell">.
|
|
├── Cargo.toml
|
|
└── src
|
|
└── main.rs
|
|
|
|
1 directory, 2 files
|
|
</code></pre>
|
|
<pre><code class="language-toml"># in Cargo.toml
|
|
[package]
|
|
name = "hello-package"
|
|
version = "0.1.0"
|
|
edition = "2021"
|
|
</code></pre>
|
|
<blockquote>
|
|
<p>Note! We will use this package across the whole chapter as a practice project.</p>
|
|
</blockquote>
|
|
<ol start="2">
|
|
<li>🌟 Create a package with below layout:</li>
|
|
</ol>
|
|
<pre><code class="language-shell">.
|
|
├── Cargo.toml
|
|
└── src
|
|
└── lib.rs
|
|
|
|
1 directory, 2 files
|
|
</code></pre>
|
|
<pre><code class="language-toml"># in Cargo.toml
|
|
[package]
|
|
name = "hello-package1"
|
|
version = "0.1.0"
|
|
edition = "2021"
|
|
</code></pre>
|
|
<blockquote>
|
|
<p>Note! This package could be safely removed due to the first one's existence.</p>
|
|
</blockquote>
|
|
<ol start="3">
|
|
<li>🌟</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">/* FILL in the blank with your ANSWER */
|
|
|
|
// Q: What's the difference between package number 1 and number 2?
|
|
// A: __</code></pre></pre>
|
|
<h2 id="crate"><a class="header" href="#crate">Crate</a></h2>
|
|
<p>A crate is a binary or library. The crate root is a source file that the Rust compiler starts from and makes up the root module of the crate.</p>
|
|
<p>In package <code>hello-package</code>, there is binary crate with the same name as the package : <code>hello-package</code>, and <code>src/main.rs</code> is the crate root of this binary crate.</p>
|
|
<p>Similar to <code>hello-package</code>, <code>hello-package1</code> also has a crate in it, however, this package doesn't contain a binary crate but a library crate, and <code>src/lib.rs</code> is the crate root.</p>
|
|
<ol start="4">
|
|
<li>🌟</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">/* FILL in the blank with your ANSWER */
|
|
|
|
// Q: What's the name of the library crate in package `hello-package1`?
|
|
// A: __</code></pre></pre>
|
|
<ol start="5">
|
|
<li>🌟🌟 Add a library crate for <code>hello-package</code> and describe it's files tree below:</li>
|
|
</ol>
|
|
<pre><code class="language-shell editable"># FILL in the blanks
|
|
.
|
|
├── Cargo.lock
|
|
├── Cargo.toml
|
|
├── src
|
|
│ ├── __
|
|
│ └── __
|
|
</code></pre>
|
|
<p>After this step, there should be two crates in package <code>hello-package</code>: <strong>a binary crate and a library crate, both with the same name as the package</strong>.</p>
|
|
<ol start="6">
|
|
<li>🌟🌟🌟 A package can contain at most one library crate, but it can contain as many binary crates as you would like by placing files in <code>src/bin</code> directory: <strong>each file will be a separate binary crate with the same name as the file</strong>.</li>
|
|
</ol>
|
|
<pre><code class="language-shell editable"># Create a package which contains
|
|
# 1. three binary crates: `hello-package`, `main1` and `main2`
|
|
# 2. one library crate
|
|
# describe the directory tree below
|
|
.
|
|
├── Cargo.toml
|
|
├── Cargo.lock
|
|
├── src
|
|
│ ├── __
|
|
│ ├── __
|
|
│ └── __
|
|
│ └── __
|
|
│ └── __
|
|
├── tests # directory for integrated tests files
|
|
│ └── some_integration_tests.rs
|
|
├── benches # dir for benchmark files
|
|
│ └── simple_bench.rs
|
|
└── examples # dir for example files
|
|
└── simple_example.rs
|
|
</code></pre>
|
|
<p>Yep, as you can see, the above package structure is very standard and is widely used in many Rust projects.</p>
|
|
<blockquote>
|
|
<p>You can find the solutions <a href="https://github.com/sunface/rust-by-practice/blob/master/solutions/crate-module/crate.md">here</a> (under the solutions path), but only use it when you need it :)</p>
|
|
</blockquote>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../crate-module/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 prefetch" href="../crate-module/module.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="../crate-module/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 prefetch" href="../crate-module/module.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>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
<script src="../ace.js"></script>
|
|
<script src="../editor.js"></script>
|
|
<script src="../mode-rust.js"></script>
|
|
<script src="../theme-dawn.js"></script>
|
|
<script src="../theme-tomorrow_night.js"></script>
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
<script src="../assets/custom3.js"></script>
|
|
<script src="../assets/lang1.js"></script>
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|