Rust 语法

1. Rust 语法

1.1. main 函数

fn main() {

}

这几行定义了一个名叫 main 的函数。main 函数是一个特殊的函数: 在可执行的 Rust 程序中, 它总是最先运行的代码。第一行代码声明了一个叫做 main 的函数, 它没有参数也没有返回值。如果有参数的话, 它们的名称应该出现在小括号 () 中。

函数体被包裹在 {} 中。Rust 要求所有函数体都要用花括号包裹起来。一般来说, 将左花括号与函数声明置于同一行并以空格分隔, 是良好的代码风格。

注: 如果你希望在 Rust 项目中保持一种标准风格, 可以使用名为 rustfmt 的自动格式化工具将代码格式化为特定的风格。Rust 团队已经在标准的 Rust 发行版中包含了这个工具, 就像 rustc 一样。所以它应该已经安装在你的电脑中了!

1.2. 代码解释

1.2.1. 处理一次猜测

文件名: src/main.rs

use std::io;

fn main() {
    println!("Guess the number!");

    println!("Please input your guess.");

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    println!("You guessed: {guess}");
}

1.2.1.1. 预导入

为了获取用户输入并打印结果作为输出, 我们需要将 io 输入/输出库引入当前作用域。io 库来自于标准库, 也被称为 std:

use std::io;

默认情况下, Rust 设定了若干个会自动导入到每个程序作用域中的标准库内容, 这组内容被称为 预导入 (preclude) 内容。你可以在 标准库文档 中查看预导入的所有内容。

如果你需要的类型不在预导入内容中, 就必须使用 use 语句显式地将其引入作用域。std::io 库提供很多有用的功能, 包括接收用户输入的功能。

1.2.1.2. 打印字符串的宏

println! 是一个在屏幕上打印字符串的宏:

    println!("Guess the number!");
    println!("Please input your guess.");

这些代码仅仅打印提示, 介绍游戏的内容然后请求用户输入。

1.2.1.3. 使用变量储存值

我们使用 let 语句来创建变量。这里是另外一个例子:

let apples = 5;

这行代码新建了一个叫做 apples 的变量并把它绑定到值 5 上。在 Rust 中, 变量默认是不可变的, 这意味着一旦我们给变量赋值, 这个值就不再可以修改了。

下面的例子展示了如何在变量名前使用 mut 来使一个变量可变:

let apples = 5; // 不可变
let mut bananas = 5; // 可变

// 语法开始一个注释, 持续到行尾。

1.2.1.4. 创建新字符串

创建一个 变量 (variable) 来储存用户输入, 像这样:

    let mut guess = String::new();

现在我们知道了 let mut guess 会引入一个叫做 guess 的可变变量。等号 (=) 告诉 Rust 我们现在想将某个值绑定在变量上。等号的右边是 guess 所绑定的值, 它是 String::new 的结果, 这个函数会返回一个 String 的新实例。String 是一个标准库提供的字符串类型, 它是 UTF-8 编码的可增长文本块。

::new 那一行的 :: 语法表明 new 是 String 类型的一个 关联函数 (associated function) 。关联函数是针对类型实现的, 在这个例子中是 String, 而不是 String 的某个特定实例。一些语言中把它称为 静态方法 (static method) 。

new 函数创建了一个新的空字符串, 你会发现很多类型上有 new 函数, 因为它是创建类型实例的惯用函数名。

总的来说, let mut guess = String::new(); 这一行创建了一个可变变量, 当前它绑定到一个新的 String 空实例上。

1.2.1.5. 接收用户输入

我们在程序的第一行使用 use std::io; 从标准库中引入了输入/输出功能。现在调用 io 库中的函数 stdin:

    io::stdin()
        .read_line(&mut guess)

如果程序的开头没有使用 use std::io 引入 io 库, 我们仍可以通过把函数调用写成 std::io::stdin 来使用函数。stdin 函数返回一个 std::io::Stdin 的实例, 这代表终端标准输入句柄的类型。

代码的下一部分, .read_line(&mut guess), 调用 read_line 方法从标准输入句柄获取用户输入。我们还将 &mut guess 作为参数传递给 read_line() 函数, 让其将用户输入储存到这个字符串中。read_line 的工作是, 无论用户在标准输入中键入什么内容, 都将其追加(不会覆盖其原有内容)到一个字符串中, 因此它需要字符串作为参数。这个字符串参数应该是可变的, 以便 read_line 将用户输入附加上去。

& 表示这个参数是一个 引用 (reference) , 它允许多处代码访问同一处数据, 而无需在内存中多次拷贝。引用是一个复杂的特性, Rust 的一个主要优势就是安全而简单的操纵引用。完成当前程序并不需要了解如此多细节。现在, 我们只需知道它像变量一样, 默认是不可变的。因此, 需要写成 &mut guess 来使其可变, 而不是 &guess。

1.2.1.6. 使用 Result 类型来处理潜在的错误

当使用 .method_name() 语法调用方法时引入换行符和空格将长的代码行拆开是明智的。

之前提到了 read_line 会将用户输入附加到传递给它的字符串中, 不过它也会返回一个类型为 Result 的值。 Result 是一种枚举类型, 通常也写作 enum。枚举类型变量的值可以是多种可能状态中的一个。我们把每种可能的状态称为一种 枚举成员 (variant) 。这里的 Result 类型将用来编码错误处理的信息。

Result 的成员是 Ok 和 Err, Ok 成员表示操作成功, 内部包含成功时产生的值。Err 成员则意味着操作失败, 并且包含失败的前因后果。

这些 Result 类型的作用是编码错误处理信息。Result 类型的值, 像其他类型一样, 拥有定义于其上的方法。Result 的实例拥有 expect 方法。如果 io::Result 实例的值是 Err, expect 会导致程序崩溃, 并显示当做参数传递给 expect 的信息。如果 read_line 方法返回 Err, 则可能是来源于底层操作系统错误的结果。如果 Result 实例的值是 Ok, expect 会获取 Ok 中的值并原样返回。在本例中, 这个值是用户输入到标准输入中的字节数。

如果不调用 expect, 程序也能编译, 不过会出现一个警告:

$ cargo build
   Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
warning: unused `Result` that must be used
  --> src/main.rs:10:5
   |
10 |     io::stdin().read_line(&mut guess);
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: `#[warn(unused_must_use)]` on by default
   = note: this `Result` may be an `Err` variant, which should be handled

warning: `guessing_game` (bin "guessing_game") generated 1 warning
    Finished dev [unoptimized + debuginfo] target(s) in 0.59s

Rust 警告我们没有使用 read_line 的返回值 Result, 说明有一个可能的错误没有处理。

消除警告的正确做法是实际去编写错误处理代码, 不过由于我们就是希望程序在出现问题时立即崩溃, 所以直接使用 expect。

1.2.1.7. 使用 println! 占位符打印值

println!("You guessed: {guess}");

这行代码现在打印了存储用户输入的字符串。第一个参数是格式化字符串, 里面的 {} 是预留在特定位置的占位符: 把 {} 想象成小蟹钳, 可以夹住合适的值。使用 {} 也可以打印多个值: 第一对 {} 使用格式化字符串之后的第一个值, 第二对则使用第二个值, 依此类推。调用一次 println! 打印多个值看起来像这样:

let x = 5;
let y = 10;

println!("x = {} and y = {}", x, y);

这行代码会打印出 x = 5 and y = 10。

1.2.2. 生成一个秘密数字

Rust 标准库中尚未包含随机数功能。然而, Rust 团队还是提供了一个包含上述功能的 rand crate。

1.2.2.1. 使用 crate 来增加更多功能

记住, crate 是一个 Rust 代码包。rand crate 是一个 库 crate, 库 crate 可以包含任意能被其他程序使用的代码, 但是不能自执行。

在我们使用 rand 编写代码之前, 需要修改 Cargo.toml 文件, 引入一个 rand 依赖。现在打开这个文件并将下面这一行添加到 [dependencies] 片段标题之下。

文件名: Cargo.toml

rand = "0.8.3"

在 Cargo.toml 文件中, 标题以及之后的内容属同一个片段, 直到遇到下一个标题才开始新的片段。[dependencies] 片段告诉 Cargo 本项目依赖了哪些外部 crate 及其版本。本例中, 我们使用语义化版本 0.8.3 来指定 rand crate。Cargo 理解 语义化版本(Semantic Versioning) (有时也称为 SemVer), 这是一种定义版本号的标准。0.8.3 事实上是 ^0.8.3 的简写, 它表示任何至少是 0.8.3 但小于 0.9.0 的版本。

Cargo 认为这些版本与 0.8.3 版本的公有 API 相兼容, 这样的版本指定确保了我们可以获取能使本章代码编译的最新的补丁(patch)版本。任何大于等于 0.9.0 的版本不能保证和接下来的示例采用了相同的 API。

在更新完 registry 后, Cargo 检查 [dependencies] 片段并下载列表中包含但还未下载的 crates 。本例中, 虽然只声明了 rand 一个依赖, 然而 Cargo 还是额外获取了 rand 所需要的其他 crates, 因为 rand 依赖它们来正常工作。

1.2.2.2. Cargo.lock 文件确保构建是可重现的

Cargo 有一个机制来确保任何人在任何时候重新构建代码, 都会产生相同的结果: Cargo 只会使用你指定的依赖版本, 除非你又手动指定了别的。例如, 如果下周 rand crate 的 0.8.4 版本出来了, 它修复了一个重要的 bug, 同时也含有一个会破坏代码运行的缺陷。为了处理这个问题, Rust 在你第一次运行 cargo build 时建立了 Cargo.lock 文件, 我们现在可以在 guessing_game 目录找到它。

当第一次构建项目时, Cargo 计算出所有符合要求的依赖版本并写入 Cargo.lock 文件。当将来构建项目时, Cargo 会发现 Cargo.lock 已存在并使用其中指定的版本, 而不是再次计算所有的版本。这使得你拥有了一个自动化的可重现的构建。换句话说, 项目会持续使用 0.8.3 直到你显式升级, 多亏有了 Cargo.lock 文件。由于 Cargo.lock 文件对于 “可重复构建” 非常重要, 因此它通常会和项目中的其余代码一样纳入到版本控制系统中。

1.2.2.3. 更新 crate 到一个新版本

当你 确实 需要升级 crate 时, Cargo 提供了这样一个命令, update, 它会忽略 Cargo.lock 文件, 并计算出所有符合 Cargo.toml 声明的最新版本。Cargo 接下来会把这些版本写入 Cargo.lock 文件。不过, Cargo 默认只会寻找大于 0.8.3 而小于 0.9.0 的版本。如果 rand crate 发布了两个新版本, 0.8.4 和 0.9.0, 在运行 cargo update 时会出现如下内容:

$ cargo update
    Updating crates.io index
    Updating rand v0.8.3 -> v0.8.4

Cargo 忽略了 0.9.0 版本。这时, 你也会注意到的 Cargo.lock 文件中的变化无外乎现在使用的 rand crate 版本是 0.8.4 。如果想要使用 0.9.0 版本的 rand 或是任何 0.9.x 系列的版本, 必须像这样更新 Cargo.toml 文件:

[dependencies]

rand = "0.9.0"

下一次运行 cargo build 时, Cargo 会从 registry 更新可用的 crate, 并根据你指定的新版本重新计算。

1.2.3. 生成一个随机数

文件名: src/main.rs

use std::io;
use rand::Rng;

fn main() {
    println!("Guess the number!");

    let secret_number = rand::thread_rng().gen_range(1..=100);

    println!("The secret number is: {secret_number}");

    println!("Please input your guess.");

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    println!("You guessed: {guess}");
}

首先, 我们新增了一行 use rand::Rng。Rng 是一个 trait, 它定义了随机数生成器应实现的方法, 想使用这些方法的话, 此 trait 必须在作用域中。

接下来, 我们在中间还新增加了两行。第一行调用了 rand::thread_rng 函数提供实际使用的随机数生成器: 它位于当前执行线程的本地环境中, 并从操作系统获取 seed。接着调用随机数生成器的 gen_range 方法。这个方法由 use rand::Rng 语句引入到作用域的 Rng trait 定义。gen_range 方法获取一个范围表达式(range expression)作为参数, 并生成一个在此范围之间的随机数。这里使用的这类范围表达式使用了 start..=end 这样的形式, 也就是说包含了上下端点, 所以需要指定 1..=100 来请求一个 1 和 100 之间的数。

注意: 你不可能凭空就知道应该 use 哪个 trait 以及该从 crate 中调用哪个方法, 因此每个 crate 有使用说明文档。Cargo 有一个很棒的功能是: 运行 cargo doc --open 命令来构建所有本地依赖提供的文档, 并在浏览器中打开。例如, 假设你对 rand crate 中的其他功能感兴趣, 你可以运行 cargo doc --open 并点击左侧导航栏中的 rand。

比较猜测的数字和秘密数字

文件名: src/main.rs

这段代码无法通过编译!

use rand::Rng;
use std::cmp::Ordering;
use std::io;

fn main() {
    // --snip--

    println!("You guessed: {guess}");

    match guess.cmp(&secret_number) {
        Ordering::Less => println!("Too small!"),
        Ordering::Greater => println!("Too big!"),
        Ordering::Equal => println!("You win!"),
    }
}

首先我们增加了另一个 use 声明, 从标准库引入了一个叫做 std::cmp::Ordering 的类型到作用域中。 Ordering 也是一个枚举, 不过它的成员是 Less、Greater 和 Equal。这是比较两个值时可能出现的三种结果。

接着, 底部的五行新代码使用了 Ordering 类型, cmp 方法用来比较两个值并可以在任何可比较的值上调用。它获取一个被比较值的引用: 这里是把 guess 与 secret_number 做比较。 然后它会返回一个刚才通过 use 引入作用域的 Ordering 枚举的成员。使用一个 match 表达式, 根据对 guess 和 secret_number 调用 cmp 返回的 Ordering 成员来决定接下来做什么。

一个 match 表达式由 分支(arms) 构成。一个分支包含一个 模式(pattern) 和表达式开头的值与分支模式相匹配时应该执行的代码。Rust 获取提供给 match 的值并挨个检查每个分支的模式。match 结构和模式是 Rust 中强大的功能, 它体现了代码可能遇到的多种情形, 并帮助你确保没有遗漏处理。

让我们看看使用 match 表达式的例子。假设用户猜了 50, 这时随机生成的秘密数字是 38。比较 50 与 38 时, 因为 50 比 38 要大, cmp 方法会返回 Ordering::Greater。Ordering::Greater 是 match 表达式得到的值。它检查第一个分支的模式, Ordering::Less 与 Ordering::Greater 并不匹配, 所以它忽略了这个分支的代码并来到下一个分支。下一个分支的模式是 Ordering::Greater, 正确 匹配! 这个分支关联的代码被执行, 在屏幕打印出 Too big!。match 表达式会在第一次成功匹配后终止, 因为该场景下没有检查最后一个分支的必要。

然而, 代码并不能编译, 可以尝试一下:

$ cargo build
   Compiling libc v0.2.86
   Compiling getrandom v0.2.2
   Compiling cfg-if v1.0.0
   Compiling ppv-lite86 v0.2.10
   Compiling rand_core v0.6.2
   Compiling rand_chacha v0.3.0
   Compiling rand v0.8.3
   Compiling guessing_game v0.1.0 (file:///projects/guessing_game)
error[E0308]: mismatched types
  --> src/main.rs:22:21
   |
22 |     match guess.cmp(&secret_number) {
   |                     ^^^^^^^^^^^^^^ expected struct `String`, found integer
   |
   = note: expected reference `&String`
              found reference `&{integer}`

error[E0283]: type annotations needed for `{integer}`
   --> src/main.rs:8:44
    |
8   |     let secret_number = rand::thread_rng().gen_range(1..=100);
    |         -------------                      ^^^^^^^^^ cannot infer type for type `{integer}`
    |         |
    |         consider giving `secret_number` a type
    |
    = note: multiple `impl`s satisfying `{integer}: SampleUniform` found in the `rand` crate:
            - impl SampleUniform for i128;
            - impl SampleUniform for i16;
            - impl SampleUniform for i32;
            - impl SampleUniform for i64;
            and 8 more
note: required by a bound in `gen_range`
   --> /Users/carolnichols/.cargo/registry/src/github.com-1ecc6299db9ec823/rand-0.8.3/src/rng.rs:129:12
    |
129 |         T: SampleUniform,
    |            ^^^^^^^^^^^^^ required by this bound in `gen_range`
help: consider specifying the type arguments in the function call
    |
8   |     let secret_number = rand::thread_rng().gen_range::<T, R>(1..=100);
    |                                                     ++++++++

Some errors have detailed explanations: E0283, E0308.
For more information about an error, try `rustc --explain E0283`.
error: could not compile `guessing_game` due to 2 previous errors

错误的核心表明这里有 不匹配的类型(mismatched types) 。Rust 有一个静态强类型系统, 同时也有类型推断。当我们写出 let guess = String::new() 时, Rust 推断出 guess 应该是 String 类型, 并不需要我们写出类型。另一方面, secret_number, 是数字类型。几个数字类型拥有 1 到 100 之间的值: 32 位数字 i32; 32 位无符号数字 u32; 64 位数字 i64 等等。Rust 默认使用 i32, 所以它是 secret_number 的类型, 除非增加类型信息, 或任何能让 Rust 推断出不同数值类型的信息。这里错误的原因在于 Rust 不会比较字符串类型和数字类型。

所以我们必须把从输入中读取到的 String 转换为一个真正的数字类型, 才好与秘密数字进行比较。这可以通过在 main 函数体中增加如下代码来实现:

文件名: src/main.rs

    // --snip--

    let mut guess = String::new();

    io::stdin()
        .read_line(&mut guess)
        .expect("Failed to read line");

    let guess: u32 = guess.trim().parse().expect("Please type a number!");

    println!("You guessed: {guess}");

    match guess.cmp(&secret_number) {
        Ordering::Less => println!("Too small!"),
        Ordering::Greater => println!("Too big!"),
        Ordering::Equal => println!("You win!"),
    }