|
|
<!DOCTYPE HTML>
|
|
|
<html lang="zh-CN" class="light sidebar-visible" dir="ltr">
|
|
|
<head>
|
|
|
<!-- Book generated using mdBook -->
|
|
|
<meta charset="UTF-8">
|
|
|
<title>基本功能 - Rust语言圣经(Rust Course)</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.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/style.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语言圣经(Rust Course)</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-course" 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-course/edit/main/src/basic-practice/base-features.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="实现基本功能"><a class="header" href="#实现基本功能">实现基本功能</a></h1>
|
|
|
<p>无论功能设计的再怎么花里胡哨，对于一个文件查找命令而言，首先得指定文件和待查找的字符串，它们需要用户从命令行给予输入，然后我们在程序内进行读取。</p>
|
|
|
<h2 id="接收命令行参数"><a class="header" href="#接收命令行参数">接收命令行参数</a></h2>
|
|
|
<p>国际惯例，先创建一个新的项目 <code>minigrep</code> ，该名字充分体现了我们的自信：就是不如 <code>grep</code>。</p>
|
|
|
<pre><code class="language-shell">cargo new minigrep
|
|
|
Created binary (application) `minigrep` project
|
|
|
$ cd minigrep
|
|
|
</code></pre>
|
|
|
<p>首先来思考下，如果要传入文件路径和待搜索的字符串，那这个命令该长啥样，我觉得大概率是这样:</p>
|
|
|
<pre><code class="language-shell">cargo run -- searchstring example-filename.txt
|
|
|
</code></pre>
|
|
|
<p><code>--</code> 告诉 <code>cargo</code> 后面的参数是给我们的程序使用的，而不是给 <code>cargo</code> 自己使用，例如 <code>--</code> 前的 <code>run</code> 就是给它用的。</p>
|
|
|
<p>接下来就是在程序中读取传入的参数，这个很简单，下面代码就可以:</p>
|
|
|
<pre><pre class="playground"><code class="language-rust edition2021">// in main.rs
|
|
|
use std::env;
|
|
|
|
|
|
fn main() {
|
|
|
let args: Vec<String> = env::args().collect();
|
|
|
dbg!(args);
|
|
|
}</code></pre></pre>
|
|
|
<p>首先通过 <code>use</code> 引入标准库中的 <code>env</code> 模块，然后 <code>env::args</code> 方法会读取并分析传入的命令行参数，最终通过 <code>collect</code> 方法输出一个集合类型 <code>Vector</code>。</p>
|
|
|
<p>可能有同学疑惑，为啥不直接引入 <code>args</code> ，例如 <code>use std::env::args</code> ，这样就无需 <code>env::args</code> 来繁琐调用，直接<code>args().collect()</code> 即可。原因很简单，<code>args</code> 方法只会使用一次，啰嗦就啰嗦点吧，把相同的好名字让给 <code>let args..</code> 这位大哥不好吗？毕竟人家要出场多次的。</p>
|
|
|
<blockquote>
|
|
|
<h3 id="不可信的输入"><a class="header" href="#不可信的输入">不可信的输入</a></h3>
|
|
|
<p>所有的用户输入都不可信！不可信！不可信！</p>
|
|
|
<p>重要的话说三遍，我们的命令行程序也是，用户会输入什么你根本就不知道，例如他输入了一个非 Unicode 字符，你能阻止吗？显然不能，但是这种输入会直接让我们的程序崩溃！</p>
|
|
|
<p>原因是当传入的命令行参数包含非 Unicode 字符时， <code>std::env::args</code> 会直接崩溃，如果有这种特殊需求，建议大家使用 <code>std::env::args_os</code>，该方法产生的数组将包含 <code>OsString</code> 类型，而不是之前的 <code>String</code> 类型，前者对于非 Unicode 字符会有更好的处理。</p>
|
|
|
<p>至于为啥我们不用，两个理由，你信哪个：1. 用户爱输入啥输入啥，反正崩溃了，他就知道自己错了 2. <code>args_os</code> 会引入额外的跨平台复杂性</p>
|
|
|
</blockquote>
|
|
|
<p><code>collect</code> 方法其实并不是<code>std::env</code>模块提供的，而是迭代器自带的方法(<code>env::args()</code> 会返回一个迭代器)，它会将迭代器消费后转换成我们想要的集合类型，关于迭代器和 <code>collect</code> 的具体介绍，请参考<a href="https://course.rs/advance/functional-programing/iterator.html">这里</a>。</p>
|
|
|
<p>最后，代码中使用 <code>dbg!</code> 宏来输出读取到的数组内容，来看看长啥样：</p>
|
|
|
<pre><code class="language-shell">$ cargo run
|
|
|
Compiling minigrep v0.1.0 (file:///projects/minigrep)
|
|
|
Finished dev [unoptimized + debuginfo] target(s) in 0.61s
|
|
|
Running `target/debug/minigrep`
|
|
|
[src/main.rs:5] args = [
|
|
|
"target/debug/minigrep",
|
|
|
]
|
|
|
</code></pre>
|
|
|
<pre><code class="language-shell">$ cargo run -- needle haystack
|
|
|
Compiling minigrep v0.1.0 (file:///projects/minigrep)
|
|
|
Finished dev [unoptimized + debuginfo] target(s) in 1.57s
|
|
|
Running `target/debug/minigrep needle haystack`
|
|
|
[src/main.rs:5] args = [
|
|
|
"target/debug/minigrep",
|
|
|
"needle",
|
|
|
"haystack",
|
|
|
]
|
|
|
</code></pre>
|
|
|
<p>上面两个版本分别是无参数和两个参数，其中无参数版本实际上也会读取到一个字符串，仔细看，是不是长得很像我们的程序名，Bingo! <code>env::args</code> 读取到的参数中第一个就是程序的可执行路径名。</p>
|
|
|
<h2 id="存储读取到的参数"><a class="header" href="#存储读取到的参数">存储读取到的参数</a></h2>
|
|
|
<p>在编程中，给予清晰合理的变量名是一项基本功，咱总不能到处都是 <code>args[1]</code> 、<code>args[2]</code> 这样的糟糕代码吧。</p>
|
|
|
<p>因此我们需要两个变量来存储文件路径和待搜索的字符串:</p>
|
|
|
<pre><pre class="playground"><code class="language-rust edition2021">use std::env;
|
|
|
|
|
|
fn main() {
|
|
|
let args: Vec<String> = env::args().collect();
|
|
|
|
|
|
let query = &args[1];
|
|
|
let file_path = &args[2];
|
|
|
|
|
|
println!("Searching for {}", query);
|
|
|
println!("In file {}", file_path);
|
|
|
}</code></pre></pre>
|
|
|
<p>很简单的代码，来运行下:</p>
|
|
|
<pre><code class="language-shell">$ cargo run -- test sample.txt
|
|
|
Compiling minigrep v0.1.0 (file:///projects/minigrep)
|
|
|
Finished dev [unoptimized + debuginfo] target(s) in 0.0s
|
|
|
Running `target/debug/minigrep test sample.txt`
|
|
|
Searching for test
|
|
|
In file sample.txt
|
|
|
</code></pre>
|
|
|
<p>输出结果很清晰的说明了我们的目标：在文件 <code>sample.txt</code> 中搜索包含 <code>test</code> 字符串的内容。</p>
|
|
|
<p>事实上，就算作为一个简单的程序，它也太过于简单了，例如用户不提供任何参数怎么办？因此，错误处理显然是不可少的，但是在添加之前，先来看看如何读取文件内容。</p>
|
|
|
<h2 id="文件读取"><a class="header" href="#文件读取">文件读取</a></h2>
|
|
|
<p>既然读取文件，那么首先我们需要创建一个文件并给予一些内容，来首诗歌如何？"我啥也不是，你呢?"</p>
|
|
|
<pre><code class="language-text">I'm nobody! Who are you?
|
|
|
我啥也不是，你呢？
|
|
|
Are you nobody, too?
|
|
|
牛逼如你也是无名之辈吗？
|
|
|
Then there's a pair of us - don't tell!
|
|
|
那我们就是天生一对，嘘！别说话！
|
|
|
They'd banish us, you know.
|
|
|
你知道，我们不属于这里。
|
|
|
How dreary to be somebody!
|
|
|
因为这里属于没劲的大人物！
|
|
|
How public, like a frog
|
|
|
他们就像青蛙一样呱噪，
|
|
|
To tell your name the livelong day
|
|
|
成天将自己的大名
|
|
|
To an admiring bog!
|
|
|
传遍整个无聊的沼泽！
|
|
|
</code></pre>
|
|
|
<p>在项目根目录创建 <code>poem.txt</code> 文件，并写入如上的优美诗歌(可能翻译的很烂，别打我，哈哈，事实上大家写入英文内容就够了)。</p>
|
|
|
<p>接下来修改 <code>main.rs</code> 来读取文件内容：</p>
|
|
|
<pre><pre class="playground"><code class="language-rust edition2021">use std::env;
|
|
|
use std::fs;
|
|
|
|
|
|
fn main() {
|
|
|
// --省略之前的内容--
|
|
|
println!("In file {}", file_path);
|
|
|
|
|
|
let contents = fs::read_to_string(file_path)
|
|
|
.expect("Should have been able to read the file");
|
|
|
|
|
|
println!("With text:\n{contents}");
|
|
|
}</code></pre></pre>
|
|
|
<p>首先，通过 <code>use std::fs</code> 引入文件操作模块，然后通过 <code>fs::read_to_string</code> 读取指定的文件内容，最后返回的 <code>contents</code> 是 <code>std::io::Result<String></code> 类型。</p>
|
|
|
<p>运行下试试，这里无需输入第二个参数，因为我们还没有实现查询功能:</p>
|
|
|
<pre><code class="language-shell">$ cargo run -- the poem.txt
|
|
|
Compiling minigrep v0.1.0 (file:///projects/minigrep)
|
|
|
Finished dev [unoptimized + debuginfo] target(s) in 0.0s
|
|
|
Running `target/debug/minigrep the poem.txt`
|
|
|
Searching for the
|
|
|
In file poem.txt
|
|
|
With text:
|
|
|
I'm nobody! Who are you?
|
|
|
Are you nobody, too?
|
|
|
Then there's a pair of us - don't tell!
|
|
|
They'd banish us, you know.
|
|
|
|
|
|
How dreary to be somebody!
|
|
|
How public, like a frog
|
|
|
To tell your name the livelong day
|
|
|
To an admiring bog!
|
|
|
</code></pre>
|
|
|
<p>完美，虽然代码还有很多瑕疵，例如所有内容都在 <code>main</code> 函数，这个不符合软件工程，没有错误处理，功能不完善等。不过没关系，万事开头难，好歹我们成功迈开了第一步。</p>
|
|
|
<p>好了，是时候重构赚波 KPI 了，读者：are you serious? 这就开始重构了？</p>
|
|
|
|
|
|
</main>
|
|
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
|
<!-- Mobile navigation buttons -->
|
|
|
<a rel="prev" href="../basic-practice/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="../basic-practice/refactoring.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="../basic-practice/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="../basic-practice/refactoring.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/custom2.js"></script>
|
|
|
<script src="../assets/bigPicture.js"></script>
|
|
|
|
|
|
|
|
|
</div>
|
|
|
</body>
|
|
|
</html>
|
