键盘快捷键

按 ← 或 → 在章节之间导航

按 S 或 / 在本书中搜索

按 ? 显示此帮助

按 Esc 隐藏此帮助

使用 Box<T> 指向堆上的数据

最直接的智能指针是 box,其类型写作 Box<T>。Box 允许你将数据存储在堆上而非栈上。栈上保留的是指向堆数据的指针。请回顾第 4 章来复习栈和堆之间的区别。

除了将数据存储在堆上而非栈上之外,Box 没有性能开销。但它们也没有太多额外的能力。你最常在以下情况中使用它们:

  • 当你有一个在编译时无法确定大小的类型,而你想在要求确切大小的上下文中使用该类型的值时
  • 当你有大量数据,想转移所有权但确保这样做时数据不会被复制时
  • 当你想拥有一个值,且只关心它是实现了某个特定 trait 的类型,而非具体某种类型时

我们将在「使用 Box 启用递归类型」中演示第一种情况。在第二种情况中,转移大量数据的所有权可能会花费很长时间,因为数据要在栈上被反复复制。为了在这种情况下提高性能,我们可以将大量数据存储在堆上的一个 box 中。这样,只有少量的指针数据在栈上被复制,而它所引用的数据则停留在堆上的一个位置。第三种情况称为trait 对象,第 18 章的「使用 Trait 对象抽象共享行为」专门讨论这个主题。所以,你在这里学到的内容将在那一节中再次应用!

在堆上存储数据

在讨论 Box<T> 的堆存储使用场景之前,我们先介绍语法以及如何与存储在 Box<T> 中的值进行交互。

Listing 15-1 展示了如何使用 box 在堆上存储一个 i32 值。

文件名:src/main.rs
fn main() {
    let b = Box::new(5);
    println!("b = {b}");
}
Listing 15-1: 使用 box 在堆上存储一个 i32 值

我们将变量 b 定义为一个指向值 5 的 Box,该值分配在堆上。这个程序会打印 b = 5;在这种情况下,我们可以像数据在栈上时那样访问 box 中的数据。就像任何拥有所有权的值一样,当 box 离开作用域时(如 b 在 main 末尾),它将被释放。释放过程既针对 box(存储在栈上),也针对它所指向的数据(存储在堆上)。

把单个值放在堆上并没有太大用处,所以你不会经常单独这样使用 box。在大多数情况下,像单个 i32 这样的值默认存储在栈上更为合适。让我们来看一个 box 允许我们定义某些类型的情况,如果没有 box,我们就无法定义这些类型。

使用 Box 启用递归类型

递归类型(recursive type)的值可以把另一个相同类型的值作为自身的一部分。递归类型带来了一个问题,因为 Rust 需要在编译时知道一个类型占用多少空间。然而,递归类型的值的嵌套在理论上可以无限继续,因此 Rust 无法知道该值需要多少空间。因为 box 有已知大小,所以我们可以通过在递归类型定义中插入一个 box 来启用递归类型。

作为递归类型的一个例子,让我们来探索 cons list。这是函数式编程语言中常见的一种数据类型。我们将要定义的 cons list 类型除了递归部分之外很简单;因此,我们将处理的示例中的概念,在你遇到更复杂的涉及递归类型的情况时也会有用。

理解 Cons List

Cons list 是一种源自 Lisp 编程语言及其方言的数据结构,由嵌套的对组成,是 Lisp 版的链表。它的名字来自 Lisp 中的 cons 函数(构造函数(construct function)的缩写),该函数用它的两个参数构造一个新的对。通过在由一个值和另一个对组成的对上调用 cons,我们可以构造由递归对组成的 cons list。

例如,以下是包含列表 1, 2, 3 的 cons list 的伪代码表示,每对都在括号中:

(1, (2, (3, Nil)))

cons list 中的每一项包含两个元素:当前项的值和下一项。列表中的最后一项只包含一个名为 Nil 的值,没有下一项。cons list 通过递归调用 cons 函数来生成。表示递归基本情况的规范名称是 Nil。注意,这与第 6 章中讨论的“null”或“nil”概念不同,后者是无效或不存在的值。

cons list 在 Rust 中不是常用的数据结构。大多数时候,当你在 Rust 中有一个元素列表时,Vec<T> 是更好的选择。其他更复杂的递归数据类型在各种情况下确实很有用,但通过在本章中从 cons list 开始,我们可以探索 box 如何让我们定义递归数据类型,而不会有太多干扰。

Listing 15-2 包含一个 cons list 的枚举定义。注意,这段代码还不能编译,因为 List 类型没有已知的大小,我们将演示这一点。

文件名:src/main.rs
enum List {
    Cons(i32, List),
    Nil,
}

fn main() {}
Listing 15-2: 首次尝试定义一个枚举来表示 i32 值的 cons list 数据结构

注意:出于本示例的目的,我们实现的是一个只保存 i32 值的 cons list。我们本可以使用泛型来实现它(正如我们在第 10 章讨论的那样),以定义一个可以存储任意类型值的 cons list 类型。

使用 List 类型来存储列表 1, 2, 3 看起来会像 Listing 15-3 中的代码。

文件名:src/main.rs
enum List {
    Cons(i32, List),
    Nil,
}

// --snip--

use crate::List::{Cons, Nil};

fn main() {
    let list = Cons(1, Cons(2, Cons(3, Nil)));
}
Listing 15-3: 使用 List 枚举来存储列表 1, 2, 3

第一个 Cons 值持有 1 和另一个 List 值。这个 List 值是另一个持有 2 和另一个 List 值的 Cons 值。这个 List 值又是一个持有 3 和一个 List 值的 Cons 值,最后是 Nil,即表示列表结束的非递归变体。

如果我们尝试编译 Listing 15-3 中的代码,会得到 Listing 15-4 中所示的错误。

$ cargo run
   Compiling cons-list v0.1.0 (file:///projects/cons-list)
error[E0072]: recursive type `List` has infinite size
 --> src/main.rs:1:1
  |
1 | enum List {
  | ^^^^^^^^^
2 |     Cons(i32, List),
  |               ---- recursive without indirection
  |
help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
  |
2 |     Cons(i32, Box<List>),
  |               ++++    +

For more information about this error, try `rustc --explain E0072`.
error: could not compile `cons-list` (bin "cons-list") due to 1 previous error
Listing 15-4: 尝试定义递归枚举时得到的错误

错误显示此类型“具有无限大小”。原因是我们用一个递归的变体定义了 List:它直接持有自身的另一个值。因此,Rust 无法弄清楚存储一个 List 值需要多少空间。让我们分解一下为什么会得到这个错误。首先,我们看看 Rust 如何决定存储一个非递归类型的值需要多少空间。

计算非递归类型的大小

回顾我们在第 6 章讨论枚举定义时在 Listing 6-2 中定义的 Message 枚举:

enum Message {
    Quit,
    Move { x: i32, y: i32 },
    Write(String),
    ChangeColor(i32, i32, i32),
}

fn main() {}

为了确定为一个 Message 值分配多少空间,Rust 会检查每个变体,看哪个变体需要最多的空间。Rust 发现 Message::Quit 不需要任何空间,Message::Move 需要足够的空间来存储两个 i32 值,等等。因为只会使用一个变体,所以一个 Message 值所需的最大空间就是存储其最大变体所需的空间。

与此相反,当 Rust 尝试确定一个递归类型(如 Listing 15-2 中的 List 枚举)需要多少空间时,情况就不同了。编译器首先查看 Cons 变体,它持有一个 i32 类型的值和一个 List 类型的值。因此,Cons 需要的空间等于一个 i32 的大小加上一个 List 的大小。为了弄清楚 List 类型需要多少内存,编译器查看各个变体,从 Cons 变体开始。Cons 变体持有一个 i32 类型的值和一个 List 类型的值,这个过程无限继续,如图 15-1 所示。

An infinite Cons list: a rectangle labeled 'Cons' split into two smaller rectangles. The first smaller rectangle holds the label 'i32', and the second smaller rectangle holds the label 'Cons' and a smaller version of the outer 'Cons' rectangle. The 'Cons' rectangles continue to hold smaller and smaller versions of themselves until the smallest comfortably sized rectangle holds an infinity symbol, indicating that this repetition goes on forever.

图 15-1:由无限个 Cons 变体组成的无限 List

获得具有已知大小的递归类型

因为 Rust 无法弄清楚为递归定义的类型分配多少空间,编译器会给出一个带有此有用建议的错误:

help: insert some indirection (e.g., a `Box`, `Rc`, or `&`) to break the cycle
  |
2 |     Cons(i32, Box<List>),
  |               ++++    +

在这个建议中,间接(indirection)意味着我们应该改变数据结构,不直接存储值,而是通过存储指向该值的指针来间接存储该值。

因为 Box<T> 是一个指针,Rust 总是知道一个 Box<T> 需要多少空间:指针的大小不会根据它所指向的数据量而改变。这意味着我们可以在 Cons 变体中放入一个 Box<T>,而不是直接放入另一个 List 值。Box<T> 将指向下一个 List 值,该值将位于堆上,而不是在 Cons 变体内部。从概念上讲,我们仍然有一个通过列表持有其他列表创建的列表,但现在这个实现更像是将项目彼此相邻放置,而不是相互嵌套。

我们可以将 Listing 15-2 中 List 枚举的定义以及 Listing 15-3 中 List 的用法改为 Listing 15-5 中的代码,这样就能编译了。

文件名:src/main.rs
enum List {
    Cons(i32, Box<List>),
    Nil,
}

use crate::List::{Cons, Nil};

fn main() {
    let list = Cons(1, Box::new(Cons(2, Box::new(Cons(3, Box::new(Nil))))));
}
Listing 15-5: 使用 Box<T> 以使 List 具有已知大小的定义

Cons 变体需要一个 i32 的大小加上存储 box 指针数据的空间。Nil 变体不存储任何值,所以它在栈上所需的空间比 Cons 变体少。现在我们知道任何 List 值将占用一个 i32 的大小加上一个 box 指针数据的大小。通过使用 box,我们打破了无限的递归链,因此编译器可以算出存储一个 List 值所需的大小。图 15-2 展示了 Cons 变体现在的样子。

A rectangle labeled 'Cons' split into two smaller rectangles. The first smaller rectangle holds the label 'i32', and the second smaller rectangle holds the label 'Box' with one inner rectangle that contains the label 'usize', representing the finite size of the box's pointer.

图 15-2:一个不是无限大小的 List,因为 Cons 持有一个 Box

Box 只提供间接性和堆分配;它们没有任何其他特殊能力,比如我们将在其他智能指针类型中看到的那些。它们也没有这些特殊能力带来的性能开销,因此它们在像 cons list 这样的情况下很有用,在这种情况下间接性是我们唯一需要的功能。我们将在第 18 章中看到更多 box 的使用场景。

Box<T> 类型是一个智能指针,因为它实现了 Deref trait,该 trait 允许 Box<T> 值被当作引用处理。当一个 Box<T> 值离开作用域时,由于 Drop trait 的实现,box 所指向的堆数据也会被清理。这两个 trait 对于我们将在本章其余部分讨论的其他智能指针类型所提供的功能将更加重要。让我们更详细地探讨这两个 trait。