闭包：捕获其环境的匿名函数
Rust 的闭包是可以保存到变量中或作为参数传递给其他函数的匿名函数。你可以在一个地方创建闭包，然后在其他地方调用闭包，以便在不同的上下文中对其求值。与函数不同，闭包可以捕获其定义范围内的值。我们将演示这些闭包特性如何实现代码重用和行为定制。
使用闭包捕获环境
我们首先考察如何使用闭包从其定义的环境中捕获值，以供以后使用。以下是场景：我们的 T 恤公司不时地会向邮件列表中的某人赠送一件独家的限量版 T 恤作为促销活动。邮件列表中的人员可以选择在其个人资料中添加自己喜欢的颜色。如果选择免费 T 恤的人员设置了自己喜欢的颜色，他们就会获得该颜色的 T 恤。如果该人员没有指定喜欢的颜色，他们就会获得公司目前库存最多的颜色。
有很多方法可以实现这一点。在本例中，我们将使用一个名为 ShirtColor 的枚举，它具有变体 Red 和 Blue （为简单起见，限制了可用颜色的数量）。我们使用一个 Inventory 结构体来表示公司的库存，该结构体具有一个名为 shirts 的字段，该字段包含一个 Vec<ShirtColor>，表示当前库存的 T 恤颜色。在 Inventory 上定义的 giveaway 方法会获取免费 T 恤中奖者的可选 T 恤颜色偏好，并返回该人员将获得的 T 恤颜色。此设置如清单 13-1 所示
#[derive(Debug, PartialEq, Copy, Clone)]
enum ShirtColor {
Red,
Blue,
}
struct Inventory {
shirts: Vec<ShirtColor>,
}
impl Inventory {
fn giveaway(&self, user_preference: Option<ShirtColor>) -> ShirtColor {
user_preference.unwrap_or_else(|| self.most_stocked())
}
fn most_stocked(&self) -> ShirtColor {
let mut num_red = 0;
let mut num_blue = 0;
for color in &self.shirts {
match color {
ShirtColor::Red => num_red += 1,
ShirtColor::Blue => num_blue += 1,
}
}
if num_red > num_blue {
ShirtColor::Red
} else {
ShirtColor::Blue
}
}
}
fn main() {
let store = Inventory {
shirts: vec![ShirtColor::Blue, ShirtColor::Red, ShirtColor::Blue],
};
let user_pref1 = Some(ShirtColor::Red);
let giveaway1 = store.giveaway(user_pref1);
println!(
"The user with preference {:?} gets {:?}",
user_pref1, giveaway1
);
let user_pref2 = None;
let giveaway2 = store.giveaway(user_pref2);
println!(
"The user with preference {:?} gets {:?}",
user_pref2, giveaway2
);
}在 main 中定义的 store 还有两件蓝色 T 恤和一件红色 T 恤可供分发以进行此限量版促销。我们为喜欢红色 T 恤的用户和没有任何偏好的用户调用 giveaway 方法。
同样，这段代码可以通过多种方式实现，而且为了专注于闭包，我们坚持了你已经学过的概念，除了使用闭包的 giveaway 方法的主体。在 giveaway 方法中，我们以 Option<ShirtColor> 类型的参数获取用户偏好，并调用 user_preference 上的 unwrap_or_else 方法。 Option<T> 上的 unwrap_or_else 方法由标准库定义。它接受一个参数：一个不带任何参数的闭包，该闭包返回一个值 T（与 Option<T> 的 Some 变体中存储的类型相同，在本例中为 ShirtColor）。如果 Option<T> 是 Some 变体，则 unwrap_or_else 返回 Some 中的值。如果 Option<T> 是 None 变体，则 unwrap_or_else 会调用闭包并返回闭包返回的值。
我们将闭包表达式 || self.most_stocked() 指定为 unwrap_or_else 的参数。这是一个本身不带参数的闭包（如果闭包有参数，它们将出现在两个竖线之间）。闭包的主体调用 self.most_stocked()。我们在此处定义闭包，如果需要结果，unwrap_or_else 的实现将在稍后求值该闭包。
运行此代码会打印
$ cargo run
Compiling shirt-company v0.1.0 (file:///projects/shirt-company)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
Running `target/debug/shirt-company`
The user with preference Some(Red) gets Red
The user with preference None gets Blue
这里有趣的一点是我们传递了一个闭包，该闭包在当前 Inventory 实例上调用 self.most_stocked()。标准库不需要知道我们定义的 Inventory 或 ShirtColor 类型，也不需要知道我们想在这种情况下使用的逻辑。闭包捕获对 self Inventory 实例的不可变引用，并将其与我们指定给 unwrap_or_else 方法的代码一起传递。另一方面，函数无法以这种方式捕获其环境。
闭包类型推断和注解
函数和闭包之间还有更多的差异。闭包通常不要求你像 fn 函数那样注释参数或返回值的类型。需要在函数上进行类型注释，因为类型是公开给用户的显式接口的一部分。严格定义此接口对于确保每个人都同意函数使用和返回什么类型的值非常重要。另一方面，闭包不是像这样在公开接口中使用的：它们存储在变量中，并且在使用时不会命名它们并将它们公开给库的用户。
闭包通常很短，并且仅在狭窄的上下文中相关，而不是在任何任意情况下都相关。在这些有限的上下文中，编译器可以推断参数和返回值的类型，类似于它如何能够推断大多数变量的类型（在极少数情况下，编译器也需要闭包类型注释）。
与变量一样，如果我们想在牺牲严格必要性的前提下增加显式性和清晰度，我们可以添加类型注释。注释闭包的类型将类似于清单 13-2 中所示的定义。在本例中，我们正在定义一个闭包并将其存储在变量中，而不是像我们在清单 13-1 中所做的那样在我们传递它作为参数的位置定义闭包。
use std::thread; use std::time::Duration; fn generate_workout(intensity: u32, random_number: u32) { let expensive_closure = |num: u32| -> u32 { println!("calculating slowly..."); thread::sleep(Duration::from_secs(2)); num }; if intensity < 25 { println!("Today, do {} pushups!", expensive_closure(intensity)); println!("Next, do {} situps!", expensive_closure(intensity)); } else { if random_number == 3 { println!("Take a break today! Remember to stay hydrated!"); } else { println!( "Today, run for {} minutes!", expensive_closure(intensity) ); } } } fn main() { let simulated_user_specified_value = 10; let simulated_random_number = 7; generate_workout(simulated_user_specified_value, simulated_random_number); }
添加类型注释后，闭包的语法看起来更像函数的语法。在此，我们定义一个函数，该函数将其参数加 1，并定义一个行为相同的闭包，以便进行比较。我们添加了一些空格来对齐相关部分。这说明了闭包语法与函数语法是如何相似的，只是使用了管道和可选的语法量
fn add_one_v1 (x: u32) -> u32 { x + 1 }
let add_one_v2 = |x: u32| -> u32 { x + 1 };
let add_one_v3 = |x| { x + 1 };
let add_one_v4 = |x| x + 1 ;第一行显示函数定义，第二行显示完全注释的闭包定义。在第三行中，我们从闭包定义中删除了类型注释。在第四行中，我们删除了方括号，这是可选的，因为闭包主体只有一个表达式。这些都是有效的定义，在调用时会产生相同的行为。add_one_v3 和 add_one_v4 行需要对闭包进行求值才能进行编译，因为类型将从它们的使用中推断出来。这类似于 let v = Vec::new(); 需要类型注释或某种类型的值插入到 Vec 中，以便 Rust 能够推断类型。
对于闭包定义，编译器将为每个参数及其返回值推断一个具体的类型。例如，清单 13-3 显示了一个简短闭包的定义，该闭包仅返回它作为参数接收的值。这个闭包除了用于本示例的目的之外，没什么用处。请注意，我们没有在定义中添加任何类型注释。由于没有类型注释，我们可以使用任何类型调用闭包，我们第一次使用 String 这样做。如果我们随后尝试使用整数调用 example_closure，我们将收到错误。
fn main() {
let example_closure = |x| x;
let s = example_closure(String::from("hello"));
let n = example_closure(5);
}编译器会给我们这个错误
$ cargo run
Compiling closure-example v0.1.0 (file:///projects/closure-example)
error[E0308]: mismatched types
--> src/main.rs:5:29
|
5 | let n = example_closure(5);
| --------------- ^- help: try using a conversion method: `.to_string()`
| | |
| | expected `String`, found integer
| arguments to this function are incorrect
|
note: expected because the closure was earlier called with an argument of type `String`
--> src/main.rs:4:29
|
4 | let s = example_closure(String::from("hello"));
| --------------- ^^^^^^^^^^^^^^^^^^^^^ expected because this argument is of type `String`
| |
| in this closure call
note: closure parameter defined here
--> src/main.rs:2:28
|
2 | let example_closure = |x| x;
| ^
For more information about this error, try `rustc --explain E0308`.
error: could not compile `closure-example` (bin "closure-example") due to 1 previous error
当我们第一次使用 String 值调用 example_closure 时，编译器会推断 x 的类型和闭包的返回类型为 String。这些类型随后被锁定到 example_closure 中的闭包中，并且当我们在下次尝试使用同一闭包使用不同类型时，我们会收到类型错误。
捕获引用或移动所有权
闭包可以通过三种方式从其环境中捕获值，这三种方式直接映射到函数采用参数的三种方式：不可变借用、可变借用和取得所有权。闭包将根据函数主体对捕获的值执行的操作来决定使用哪一种。
在清单 13-4 中，我们定义了一个闭包，该闭包捕获对名为 list 的向量的不可变引用，因为它只需要一个不可变引用即可打印该值
fn main() { let list = vec![1, 2, 3]; println!("Before defining closure: {list:?}"); let only_borrows = || println!("From closure: {list:?}"); println!("Before calling closure: {list:?}"); only_borrows(); println!("After calling closure: {list:?}"); }
此示例还说明了变量可以绑定到闭包定义，并且我们以后可以通过使用变量名称和括号（就像变量名称是函数名称一样）来调用该闭包。
由于我们可以同时对 list 拥有多个不可变引用，因此在闭包定义之前、闭包定义之后但在调用闭包之前以及调用闭包之后，仍然可以从代码访问 list。此代码编译、运行和打印
$ cargo run
Locking 1 package to latest compatible version
Adding closure-example v0.1.0 (/Users/chris/dev/rust-lang/book/tmp/listings/ch13-functional-features/listing-13-04)
Compiling closure-example v0.1.0 (file:///projects/closure-example)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
Running `target/debug/closure-example`
Before defining closure: [1, 2, 3]
Before calling closure: [1, 2, 3]
From closure: [1, 2, 3]
After calling closure: [1, 2, 3]
接下来，在清单 13-5 中，我们更改闭包主体，使其向 list 向量添加元素。闭包现在捕获可变引用
fn main() { let mut list = vec![1, 2, 3]; println!("Before defining closure: {list:?}"); let mut borrows_mutably = || list.push(7); borrows_mutably(); println!("After calling closure: {list:?}"); }
此代码编译、运行和打印
$ cargo run
Locking 1 package to latest compatible version
Adding closure-example v0.1.0 (/Users/chris/dev/rust-lang/book/tmp/listings/ch13-functional-features/listing-13-05)
Compiling closure-example v0.1.0 (file:///projects/closure-example)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
Running `target/debug/closure-example`
Before defining closure: [1, 2, 3]
After calling closure: [1, 2, 3, 7]
请注意，在 borrows_mutably 闭包的定义和调用之间不再存在 println!：定义 borrows_mutably 时，它会捕获对 list 的可变引用。在调用闭包后，我们不再使用该闭包，因此可变借用结束。在闭包定义和闭包调用之间，不允许打印的不可变借用，因为当存在可变借用时，不允许其他任何借用。尝试在那里添加 println! 以查看你收到的错误消息！
如果你想强制闭包取得它在环境中使用的值的所有权，即使闭包主体实际上不需要所有权，你也可以在参数列表之前使用 move 关键字。
此技术在将闭包传递给新线程以移动数据以便该数据归新线程所有时最有用。我们将在第 16 章讨论并发时详细讨论线程以及为什么要使用线程，但现在，让我们简要地探讨一下使用需要 move 关键字的闭包来生成新线程。清单 13-6 显示了经过修改的清单 13-4，以在新线程而不是主线程中打印向量
use std::thread; fn main() { let list = vec![1, 2, 3]; println!("Before defining closure: {list:?}"); thread::spawn(move || println!("From thread: {list:?}")) .join() .unwrap(); }
move 强制线程的闭包取得 list 的所有权我们生成一个新线程，并为线程提供一个闭包作为参数运行。闭包主体会打印列表。在清单 13-4 中，闭包仅使用不可变引用捕获了 list，因为这是打印它所需的最少 list 访问量。在本示例中，即使闭包主体仍然只需要一个不可变引用，我们仍需要通过在闭包定义的开头放置 move 关键字来指定 list 应移动到闭包中。新线程可能会在主线程的其余部分完成之前完成，或者主线程可能会先完成。如果主线程保持对 list 的所有权，但在新线程执行完毕之前结束并丢弃 list，则线程中的不可变引用将无效。因此，编译器要求将 list 移动到提供给新线程的闭包中，以便该引用有效。尝试删除 move 关键字或在定义闭包后在主线程中使用 list 以查看你收到的编译器错误！
将捕获的值移出闭包和 Fn 特征
一旦闭包捕获了定义该闭包的环境中的值的引用或所有权（从而影响了什么值被移入闭包），闭包体内的代码就定义了当稍后评估闭包时，引用或值会发生什么（从而影响了什么值被移出闭包）。闭包体可以执行以下任何操作：将捕获的值移出闭包、修改捕获的值、既不移动也不修改值，或者从一开始就什么也不捕获。
闭包捕获和处理环境中值的方式会影响闭包实现的 trait，而 trait 是函数和结构体如何指定它们可以使用的闭包类型。闭包将自动以附加的方式实现 Fn 的三个 trait 中的一个、两个或全部，具体取决于闭包体如何处理这些值。
FnOnce适用于只能调用一次的闭包。所有闭包至少都实现了这个 trait，因为所有闭包都可以被调用。将其捕获的值移出其主体的闭包将只实现FnOnce，而不实现其他任何Fntrait，因为它只能被调用一次。FnMut适用于不将其捕获的值移出主体，但可能会修改捕获的值的闭包。这些闭包可以被调用多次。Fn适用于不将其捕获的值移出主体，并且不修改捕获的值的闭包，以及从环境中不捕获任何内容的闭包。这些闭包可以被多次调用，而不会修改它们的环境，这在多次并发调用闭包的情况下非常重要。
让我们看一下我们在列表 13-1 中使用的 Option<T> 上的 unwrap_or_else 方法的定义
impl<T> Option<T> {
pub fn unwrap_or_else<F>(self, f: F) -> T
where
F: FnOnce() -> T
{
match self {
Some(x) => x,
None => f(),
}
}
}回想一下，T 是表示 Option 的 Some 变体中值的类型的泛型类型。类型 T 也是 unwrap_or_else 函数的返回类型：例如，在 Option<String> 上调用 unwrap_or_else 的代码将得到一个 String。
接下来，请注意 unwrap_or_else 函数具有额外的泛型类型参数 F。F 类型是名为 f 的参数的类型，它是我们调用 unwrap_or_else 时提供的闭包。
在泛型类型 F 上指定的 trait 界限是 FnOnce() -> T，这意味着 F 必须能够被调用一次，不接受任何参数，并返回一个 T。在 trait 界限中使用 FnOnce 表示 unwrap_or_else 最多只会调用 f 一次的约束。在 unwrap_or_else 的主体中，我们可以看到如果 Option 是 Some，则不会调用 f。如果 Option 是 None，则会调用 f 一次。因为所有闭包都实现了 FnOnce，所以 unwrap_or_else 接受所有三种类型的闭包，并且尽可能灵活。
注意：函数也可以实现所有三个 Fn trait。如果我们要执行的操作不需要从环境中捕获值，那么当我们需要实现 Fn trait 之一的东西时，我们可以使用函数的名称而不是闭包。例如，在 Option<Vec<T>> 值上，如果该值为 None，我们可以调用 unwrap_or_else(Vec::new) 来获取一个新的空向量。
现在让我们看看切片上定义的标准库方法 sort_by_key，看看它与 unwrap_or_else 有何不同，以及为什么 sort_by_key 对 trait 界限使用 FnMut 而不是 FnOnce。该闭包以对正在考虑的切片中当前项的引用的形式获得一个参数，并返回一个可以排序的 K 类型的值。当您想按每个项的特定属性对切片进行排序时，此函数非常有用。在列表 13-7 中，我们有一个 Rectangle 实例列表，我们使用 sort_by_key 按其 width 属性从小到大对其进行排序
#[derive(Debug)] struct Rectangle { width: u32, height: u32, } fn main() { let mut list = [ Rectangle { width: 10, height: 1 }, Rectangle { width: 3, height: 5 }, Rectangle { width: 7, height: 12 }, ]; list.sort_by_key(|r| r.width); println!("{list:#?}"); }
sort_by_key 按宽度对矩形进行排序此代码打印
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.41s
Running `target/debug/rectangles`
[
Rectangle {
width: 3,
height: 5,
},
Rectangle {
width: 7,
height: 12,
},
Rectangle {
width: 10,
height: 1,
},
]
sort_by_key 被定义为接受 FnMut 闭包的原因是它会多次调用该闭包：切片中的每个项调用一次。闭包 |r| r.width 不会从其环境中捕获、修改或移出任何内容，因此它满足 trait 界限的要求。
相反，列表 13-8 显示了一个仅实现 FnOnce trait 的闭包示例，因为它将一个值移出环境。编译器不允许我们将此闭包与 sort_by_key 一起使用
#[derive(Debug)]
struct Rectangle {
width: u32,
height: u32,
}
fn main() {
let mut list = [
Rectangle { width: 10, height: 1 },
Rectangle { width: 3, height: 5 },
Rectangle { width: 7, height: 12 },
];
let mut sort_operations = vec![];
let value = String::from("closure called");
list.sort_by_key(|r| {
sort_operations.push(value);
r.width
});
println!("{list:#?}");
}FnOnce 闭包与 sort_by_key 一起使用这是一种人为的、复杂的方法（不起作用）来尝试计算 sort_by_key 在排序 list 时调用闭包的次数。此代码尝试通过将 value（闭包环境中的 String）推入 sort_operations 向量来执行此计数。该闭包捕获 value，然后通过将 value 的所有权转移到 sort_operations 向量来将 value 移出闭包。此闭包可以被调用一次；尝试第二次调用它将不起作用，因为 value 将不再在环境中再次被推入 sort_operations！因此，此闭包仅实现 FnOnce。当我们尝试编译此代码时，我们得到了此错误，即无法将 value 移出闭包，因为该闭包必须实现 FnMut
$ cargo run
Compiling rectangles v0.1.0 (file:///projects/rectangles)
error[E0507]: cannot move out of `value`, a captured variable in an `FnMut` closure
--> src/main.rs:18:30
|
15 | let value = String::from("closure called");
| ----- captured outer variable
16 |
17 | list.sort_by_key(|r| {
| --- captured by this `FnMut` closure
18 | sort_operations.push(value);
| ^^^^^ move occurs because `value` has type `String`, which does not implement the `Copy` trait
|
help: consider cloning the value if the performance cost is acceptable
|
18 | sort_operations.push(value.clone());
| ++++++++
For more information about this error, try `rustc --explain E0507`.
error: could not compile `rectangles` (bin "rectangles") due to 1 previous error
该错误指向闭包主体中将 value 移出环境的行。要解决此问题，我们需要更改闭包主体，使其不会将值移出环境。要计算调用闭包的次数，在环境中保留一个计数器并在闭包主体中递增其值是一种更直接的计算方式。列表 13-9 中的闭包可以与 sort_by_key 一起使用，因为它仅捕获对 num_sort_operations 计数器的可变引用，因此可以被多次调用
#[derive(Debug)] struct Rectangle { width: u32, height: u32, } fn main() { let mut list = [ Rectangle { width: 10, height: 1 }, Rectangle { width: 3, height: 5 }, Rectangle { width: 7, height: 12 }, ]; let mut num_sort_operations = 0; list.sort_by_key(|r| { num_sort_operations += 1; r.width }); println!("{list:#?}, sorted in {num_sort_operations} operations"); }
FnMut 闭包与 sort_by_key 一起使用当定义或使用利用闭包的函数或类型时，Fn trait 非常重要。在下一节中，我们将讨论迭代器。许多迭代器方法都接受闭包参数，因此请记住这些闭包详细信息，我们将继续！