函数

函数在 Rust 代码中很普遍。你已经见过该语言中最重要的函数之一:main 函数,它是许多程序的入口点。你也已经见过 fn 关键字,它允许你声明新函数。

Rust 代码使用蛇形命名法作为函数和变量名称的传统风格,其中所有字母都是小写的,并且使用下划线分隔单词。这是一个包含示例函数定义的程序

文件名:src/main.rs

fn main() {
    println!("Hello, world!");

    another_function();
}

fn another_function() {
    println!("Another function.");
}

我们在 Rust 中定义一个函数,输入 fn,后跟函数名称和一组圆括号。大括号告诉编译器函数体的开始和结束位置。

我们可以通过输入其名称后跟一组圆括号来调用我们定义的任何函数。因为 another_function 在程序中定义,所以它可以从 main 函数内部调用。请注意,我们在源代码中 main 函数之后定义了 another_function;我们也可以在其之前定义它。Rust 不关心你在哪里定义函数,只关心它们是否在调用者可见的范围内定义。

让我们启动一个名为 functions 的新二进制项目,以进一步探索函数。将 another_function 示例放在 src/main.rs 中并运行它。你应该看到以下输出

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.28s
     Running `target/debug/functions`
Hello, world!
Another function.

这些行按照它们在 main 函数中出现的顺序执行。首先打印“Hello, world!”消息,然后调用 another_function 并打印其消息。

参数

我们可以定义函数具有参数,参数是函数签名的一部分的特殊变量。当函数具有参数时,你可以为其提供这些参数的具体值。从技术上讲,具体值称为实参,但在日常对话中,人们倾向于互换使用参数实参这两个词,表示函数定义中的变量或调用函数时传入的具体值。

在此版本的 another_function 中,我们添加了一个参数

文件名:src/main.rs

fn main() {
    another_function(5);
}

fn another_function(x: i32) {
    println!("The value of x is: {x}");
}

尝试运行此程序;你应该得到以下输出

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.21s
     Running `target/debug/functions`
The value of x is: 5

another_function 的声明有一个名为 x 的参数。x 的类型指定为 i32。当我们向 another_function 传递 5 时,println! 宏将 5 放在格式字符串中包含 x 的一对大括号的位置。

在函数签名中,你必须声明每个参数的类型。这是 Rust 设计中的一个深思熟虑的决定:在函数定义中需要类型注释意味着编译器几乎不需要你在代码中的其他地方使用它们来弄清楚你的意思。如果编译器知道函数期望的类型,它也能够提供更有用的错误消息。

在定义多个参数时,使用逗号分隔参数声明,如下所示

文件名:src/main.rs

fn main() {
    print_labeled_measurement(5, 'h');
}

fn print_labeled_measurement(value: i32, unit_label: char) {
    println!("The measurement is: {value}{unit_label}");
}

此示例创建一个名为 print_labeled_measurement 的函数,该函数具有两个参数。第一个参数名为 value,类型为 i32。第二个参数名为 unit_label,类型为 char。然后,该函数打印包含 valueunit_label 的文本。

让我们尝试运行此代码。将当前在你的 functions 项目的 src/main.rs 文件中的程序替换为前面的示例,并使用 cargo run 运行它

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.31s
     Running `target/debug/functions`
The measurement is: 5h

因为我们使用 5 作为 value 的值,使用 'h' 作为 unit_label 的值调用了该函数,所以程序输出包含这些值。

语句和表达式

函数体由一系列语句组成,可以选择以表达式结尾。到目前为止,我们介绍的函数不包含结尾表达式,但你已经看到表达式作为语句的一部分。因为 Rust 是一种基于表达式的语言,所以理解这种重要的区别至关重要。其他语言没有相同的区别,所以让我们看看语句和表达式是什么,以及它们的差异如何影响函数体。

  • 语句是执行某些操作并且不返回值 的指令。
  • 表达式计算结果为某个值。让我们看一些示例。

实际上,我们已经使用过语句和表达式。使用 let 关键字创建变量并为其赋值是一个语句。在清单 3-1 中,let y = 6; 是一个语句。

文件名:src/main.rs
fn main() {
    let y = 6;
}
清单 3-1:包含一个语句的 main 函数声明

函数定义也是语句;整个前面的示例本身就是一个语句。(如下所述,调用函数不是语句。)

语句不返回值。因此,你不能将 let 语句分配给另一个变量,如下面的代码尝试执行的操作;你会收到错误

文件名:src/main.rs

fn main() {
    let x = (let y = 6);
}

当你运行此程序时,你将得到的错误如下所示

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
error: expected expression, found `let` statement
 --> src/main.rs:2:14
  |
2 |     let x = (let y = 6);
  |              ^^^
  |
  = note: only supported directly in conditions of `if` and `while` expressions

warning: unnecessary parentheses around assigned value
 --> src/main.rs:2:13
  |
2 |     let x = (let y = 6);
  |             ^         ^
  |
  = note: `#[warn(unused_parens)]` on by default
help: remove these parentheses
  |
2 -     let x = (let y = 6);
2 +     let x = let y = 6;
  |

warning: `functions` (bin "functions") generated 1 warning
error: could not compile `functions` (bin "functions") due to 1 previous error; 1 warning emitted

let y = 6 语句不返回值,因此 x 没有可以绑定到的内容。这与其他语言(如 C 和 Ruby)中的行为不同,在这些语言中,赋值返回赋值的值。在这些语言中,你可以编写 x = y = 6 并使 xy 都具有值 6;在 Rust 中不是这种情况。

表达式计算结果为值,并构成你在 Rust 中编写的大部分代码。考虑一个数学运算,例如 5 + 6,这是一个计算结果为值 11 的表达式。表达式可以是语句的一部分:在清单 3-1 中,语句 let y = 6; 中的 6 是一个计算结果为值 6 的表达式。调用函数是一个表达式。调用宏是一个表达式。用大括号创建的新作用域块是一个表达式,例如

文件名:src/main.rs

fn main() {
    let y = {
        let x = 3;
        x + 1
    };

    println!("The value of y is: {y}");
}

这个表达式

{
    let x = 3;
    x + 1
}

是一个块,在这种情况下,它计算结果为 4。该值作为 let 语句的一部分绑定到 y。请注意,x + 1 行的末尾没有分号,这与你到目前为止看到的大多数行不同。表达式不包括结尾的分号。如果你在表达式末尾添加分号,则将其转换为语句,然后它将不返回值。在接下来探索函数返回值和表达式时,请记住这一点。

具有返回值的函数

函数可以将值返回给调用它们的代码。我们不命名返回值,但我们必须在箭头 (->) 之后声明它们的类型。在 Rust 中,函数的返回值与函数体块中最后一个表达式的值同义。你可以使用 return 关键字并指定一个值从函数提前返回,但大多数函数会隐式返回最后一个表达式。这是一个返回值的函数示例

文件名:src/main.rs

fn five() -> i32 {
    5
}

fn main() {
    let x = five();

    println!("The value of x is: {x}");
}

five 函数中没有函数调用、宏甚至 let 语句,只有数字 5 本身。这在 Rust 中是一个完全有效的函数。请注意,函数的返回类型也指定为 -> i32。尝试运行此代码;输出应如下所示

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.30s
     Running `target/debug/functions`
The value of x is: 5

five 中的 5 是函数的返回值,这就是返回类型为 i32 的原因。让我们更详细地检查这一点。有两个重要的部分:首先,let x = five(); 行表明我们正在使用函数的返回值来初始化变量。因为函数 five 返回 5,所以该行与以下行相同

#![allow(unused)]
fn main() {
let x = 5;
}

其次,five 函数没有参数并定义返回值的类型,但函数体是一个孤零零的 5,没有分号,因为它是一个我们想要返回其值的表达式。

让我们看另一个示例

文件名:src/main.rs

fn main() {
    let x = plus_one(5);

    println!("The value of x is: {x}");
}

fn plus_one(x: i32) -> i32 {
    x + 1
}

运行此代码将打印 The value of x is: 6。但是,如果我们在包含 x + 1 的行的末尾放置一个分号,将其从表达式更改为语句,我们将收到错误

文件名:src/main.rs

fn main() {
    let x = plus_one(5);

    println!("The value of x is: {x}");
}

fn plus_one(x: i32) -> i32 {
    x + 1;
}

编译此代码会产生一个错误,如下所示

$ cargo run
   Compiling functions v0.1.0 (file:///projects/functions)
error[E0308]: mismatched types
 --> src/main.rs:7:24
  |
7 | fn plus_one(x: i32) -> i32 {
  |    --------            ^^^ expected `i32`, found `()`
  |    |
  |    implicitly returns `()` as its body has no tail or `return` expression
8 |     x + 1;
  |          - help: remove this semicolon to return this value

For more information about this error, try `rustc --explain E0308`.
error: could not compile `functions` (bin "functions") due to 1 previous error

主要错误消息 mismatched types 揭示了此代码的核心问题。函数 plus_one 的定义表明它将返回一个 i32,但是语句不会计算为值,这由 ()(单元类型)表示。因此,没有返回任何内容,这与函数定义相矛盾并导致错误。在此输出中,Rust 提供了一条消息来帮助纠正此问题:它建议删除分号,这将修复错误。