mirror of
https://github.com/sunface/rust-by-practice.git
synced 2025-06-25 21:49:41 +00:00
384 lines
16 KiB
HTML
384 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Module - 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/module.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="module"><a class="header" href="#module">Module</a></h1>
|
|
<p>Modules let us organize the code within a crate into groups for readability and ease of reuse. Module also controls the privacy of items, which is whether an item can be seen by outside code( public ), or is just an internal implementation and not available for outside code( private ).</p>
|
|
<p>We have created a package named <code>hello-package</code> in previous chapter, and it looks like this:</p>
|
|
<pre><code class="language-shell">.
|
|
├── Cargo.toml
|
|
├── src
|
|
│ ├── lib.rs
|
|
│ └── main.rs
|
|
</code></pre>
|
|
<p>Now it's time to create some modules in the library crate and use them in the binary crate, let's start.</p>
|
|
<ol>
|
|
<li>🌟🌟 Implement module <code>front_of_house</code> based on the module tree below:</li>
|
|
</ol>
|
|
<pre><code class="language-shell">library crate root
|
|
└── front_of_house
|
|
├── hosting
|
|
│ ├── add_to_waitlist
|
|
│ └── seat_at_table
|
|
└── serving
|
|
├── take_order
|
|
├── serve_order
|
|
├── take_payment
|
|
└── complain
|
|
</code></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// FILL in the blank
|
|
// in __.rs
|
|
|
|
mod front_of_house {
|
|
// IMPLEMENT this module..
|
|
}</code></pre></pre>
|
|
<ol start="2">
|
|
<li>🌟🌟 Let's call <code>add_to_waitlist</code> from a function <code>eat_at_restaurant</code> which is within the library crate root.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In lib.rs
|
|
|
|
// FILL in the blanks and FIX the errors
|
|
// You need to make something public with `pub` to provide accessibility for outside code `fn eat_at_restaurant()`
|
|
mod front_of_house {
|
|
/* ...snip... */
|
|
}
|
|
|
|
pub fn eat_at_restaurant() {
|
|
// Call add_to_waitlist with **absolute path**:
|
|
__::add_to_waitlist();
|
|
|
|
// Call with **relative path**
|
|
__::add_to_waitlist();
|
|
}</code></pre></pre>
|
|
<ol start="3">
|
|
<li>🌟🌟 You can use <code>super</code> to import items within the parent module</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In lib.rs
|
|
|
|
mod back_of_house {
|
|
fn fix_incorrect_order() {
|
|
cook_order();
|
|
// FILL in the blank in three ways
|
|
//1. using keyword `super`
|
|
//2. using absolute path
|
|
__::serve_order();
|
|
}
|
|
|
|
fn cook_order() {}
|
|
}</code></pre></pre>
|
|
<h3 id="separating-modules-into-different-files"><a class="header" href="#separating-modules-into-different-files">Separating modules into different files</a></h3>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In lib.rs
|
|
pub mod front_of_house {
|
|
pub mod hosting {
|
|
pub fn add_to_waitlist() {}
|
|
|
|
pub fn seat_at_table() -> String {
|
|
String::from("sit down please")
|
|
}
|
|
}
|
|
|
|
pub mod serving {
|
|
pub fn take_order() {}
|
|
|
|
pub fn serve_order() {}
|
|
|
|
pub fn take_payment() {}
|
|
|
|
// Maybe you don't want the guest hearing the your complaining about them
|
|
// So just make it private
|
|
fn complain() {}
|
|
}
|
|
}
|
|
|
|
pub fn eat_at_restaurant() -> String {
|
|
front_of_house::hosting::add_to_waitlist();
|
|
|
|
back_of_house::cook_order();
|
|
|
|
String::from("yummy yummy!")
|
|
}
|
|
|
|
pub mod back_of_house {
|
|
pub fn fix_incorrect_order() {
|
|
cook_order();
|
|
crate::front_of_house::serving::serve_order();
|
|
}
|
|
|
|
pub fn cook_order() {}
|
|
}</code></pre></pre>
|
|
<ol start="4">
|
|
<li>🌟🌟🌟🌟 Please separate the modules and codes above into files resident in below dir tree :</li>
|
|
</ol>
|
|
<pre><code class="language-shell">.
|
|
├── Cargo.toml
|
|
├── src
|
|
│ ├── back_of_house.rs
|
|
│ ├── front_of_house
|
|
│ │ ├── hosting.rs
|
|
│ │ ├── mod.rs
|
|
│ │ └── serving.rs
|
|
│ ├── lib.rs
|
|
│ └── main.rs
|
|
</code></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/lib.rs
|
|
|
|
// IMPLEMENT...</code></pre></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/back_of_house.rs
|
|
|
|
// IMPLEMENT...</code></pre></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/front_of_house/mod.rs
|
|
|
|
// IMPLEMENT...</code></pre></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/front_of_house/hosting.rs
|
|
|
|
// IMPLEMENT...</code></pre></pre>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/front_of_house/serving.rs
|
|
|
|
// IMPLEMENT...</code></pre></pre>
|
|
<h3 id="accessing-code-in-library-crate-from-binary-crate"><a class="header" href="#accessing-code-in-library-crate-from-binary-crate">Accessing code in library crate from binary crate</a></h3>
|
|
<p><strong>Please ensure you have completed the 4th exercise before making further progress.</strong></p>
|
|
<p>You should have below structures and the corresponding codes in them when reaching here:</p>
|
|
<pre><code class="language-shell">.
|
|
├── Cargo.toml
|
|
├── src
|
|
│ ├── back_of_house.rs
|
|
│ ├── front_of_house
|
|
│ │ ├── hosting.rs
|
|
│ │ ├── mod.rs
|
|
│ │ └── serving.rs
|
|
│ ├── lib.rs
|
|
│ └── main.rs
|
|
</code></pre>
|
|
<ol start="5">
|
|
<li>🌟🌟🌟 Now we will call a few library functions from the binary crate.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">// In src/main.rs
|
|
|
|
// FILL in the blank and FIX the errors
|
|
fn main() {
|
|
assert_eq!(__, "sit down please");
|
|
assert_eq!(__,"yummy yummy!");
|
|
}</code></pre></pre>
|
|
<blockquote>
|
|
<p>You can find the solutions <a href="https://github.com/sunface/rust-by-practice/blob/master/solutions/crate-module/module.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/crate.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/use-pub.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/crate.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/use-pub.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>
|