Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

泛型数据类型(Generic Data Types)

我们使用泛型来创建函数签名或结构体等项的定义,然后我们可以将这些定义用于许多不同的具体数据类型。让我们首先看看如何使用泛型定义函数、结构体、枚举和方法。然后,我们将讨论泛型如何影响代码性能。

在函数定义中

在定义使用泛型的函数时,我们将泛型放在函数签名中通常指定参数和返回值数据类型的位置。这样做使我们的代码更灵活,为函数的调用者提供更多功能,同时防止代码重复。

继续我们的 largest 函数,示例 10-4 展示了两个都在切片中查找最大值的函数。然后,我们将它们合并为一个使用泛型的函数。

Filename: src/main.rs
fn largest_i32(list: &[i32]) -> &i32 {
    let mut largest = &list[0];

    for item in list {
        if item > largest {
            largest = item;
        }
    }

    largest
}

fn largest_char(list: &[char]) -> &char {
    let mut largest = &list[0];

    for item in list {
        if item > largest {
            largest = item;
        }
    }

    largest
}

fn main() {
    let number_list = vec![34, 50, 25, 100, 65];

    let result = largest_i32(&number_list);
    println!("The largest number is {result}");
    assert_eq!(*result, 100);

    let char_list = vec!['y', 'm', 'a', 'q'];

    let result = largest_char(&char_list);
    println!("The largest char is {result}");
    assert_eq!(*result, 'y');
}
Listing 10-4: 仅在名称和签名中的类型上不同的两个函数

largest_i32 函数是我们在示例 10-3 中提取的函数,用于在切片中查找最大的 i32largest_char 函数用于在切片中查找最大的 char。函数体具有相同的代码,因此让我们通过在一个函数中引入泛型类型参数来消除重复。

要参数化新函数中的类型,我们需要命名类型参数,就像我们对函数的值参数所做的那样。你可以使用任何标识符作为类型参数名称。但我们将使用 T,因为按照惯例,Rust 中的类型参数名称很短,通常只有一个字母,并且 Rust 的类型命名约定是 UpperCamelCase。作为 type 的缩写,T 是大多数 Rust 程序员的默认选择。

当我们在函数体中使用参数时,必须在签名中声明参数名称,以便编译器知道该名称的含义。类似地,当我们在函数签名中使用类型参数名称时,必须在使用它之前声明类型参数名称。要定义泛型 largest 函数,我们将类型名称声明放在尖括号 <> 中,位于函数名称和参数列表之间,如下所示:

fn largest<T>(list: &[T]) -> &T {

我们将这个定义解读为:“函数 largest 在某种类型 T 上是泛型的。“这个函数有一个名为 list 的参数,它是类型 T 的值的切片。largest 函数将返回对相同类型 T 的值的引用。

示例 10-5 展示了在其签名中使用泛型数据类型的组合 largest 函数定义。该清单还展示了如何使用 i32 值切片或 char 值切片调用该函数。请注意,这段代码还不能编译。

Filename: src/main.rs
fn largest<T>(list: &[T]) -> &T {
    let mut largest = &list[0];

    for item in list {
        if item > largest {
            largest = item;
        }
    }

    largest
}

fn main() {
    let number_list = vec![34, 50, 25, 100, 65];

    let result = largest(&number_list);
    println!("The largest number is {result}");

    let char_list = vec!['y', 'm', 'a', 'q'];

    let result = largest(&char_list);
    println!("The largest char is {result}");
}
Listing 10-5: 使用泛型类型参数的 largest 函数;这段代码还不能编译

如果我们现在编译这段代码,将得到以下错误:

$ cargo run
   Compiling chapter10 v0.1.0 (file:///projects/chapter10)
error[E0369]: binary operation `>` cannot be applied to type `&T`
 --> src/main.rs:5:17
  |
5 |         if item > largest {
  |            ---- ^ ------- &T
  |            |
  |            &T
  |
help: consider restricting type parameter `T` with trait `PartialOrd`
  |
1 | fn largest<T: std::cmp::PartialOrd>(list: &[T]) -> &T {
  |             ++++++++++++++++++++++

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

帮助文本提到了 std::cmp::PartialOrd,这是一个 trait,我们将在下一节讨论 trait。现在,要知道这个错误表明 largest 的函数体对于 T 可能的所有类型不能都工作。因为我们在函数体中想要比较 T 类型的值,我们只能使用其值可以排序的类型。为了启用比较,标准库提供了 std::cmp::PartialOrd trait,你可以在类型上实现它(有关此 trait 的更多信息,请参见附录 C)。要修复示例 10-5,我们可以遵循帮助文本的建议,将 T 的有效类型限制为仅实现了 PartialOrd 的类型。然后该清单将编译,因为标准库在 i32char 上都实现了 PartialOrd

在结构体定义中

我们也可以使用 <> 语法定义结构体,在一个或多个字段中使用泛型类型参数。示例 10-6 定义了一个 Point<T> 结构体,用于保存任何类型的 xy 坐标值。

Filename: src/main.rs
struct Point<T> {
    x: T,
    y: T,
}

fn main() {
    let integer = Point { x: 5, y: 10 };
    let float = Point { x: 1.0, y: 4.0 };
}
Listing 10-6: 一个保存类型 Txy 值的 Point<T> 结构体

在结构体定义中使用泛型的语法与在函数定义中使用的语法类似。首先,我们在结构体名称之后立即在尖括号内声明类型参数的名称。然后,我们在结构体定义中原本会指定具体数据类型的地方使用泛型类型。

请注意,因为我们只使用了一个泛型类型来定义 Point<T>,所以这个定义表明 Point<T> 结构体在某种类型 T 上是泛型的,并且字段 xy 都是相同的类型,无论该类型可能是什么。如果我们创建一个具有不同类型的值的 Point<T> 实例,如示例 10-7 所示,我们的代码将无法编译。

Filename: src/main.rs
struct Point<T> {
    x: T,
    y: T,
}

fn main() {
    let wont_work = Point { x: 5, y: 4.0 };
}
Listing 10-7: 字段 xy 必须是相同类型,因为它们都具有相同的泛型数据类型 T

在这个例子中,当我们将整数值 5 赋给 x 时,我们让编译器知道泛型类型 T 对于这个 Point<T> 实例将是整数。然后,当我们为 y 指定 4.0(我们已经定义它与 x 具有相同的类型)时,我们将得到一个类型不匹配错误,如下所示:

$ cargo run
   Compiling chapter10 v0.1.0 (file:///projects/chapter10)
error[E0308]: mismatched types
 --> src/main.rs:7:38
  |
7 |     let wont_work = Point { x: 5, y: 4.0 };
  |                                      ^^^ expected integer, found floating-point number

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

要定义一个 Point 结构体,其中 xy 都是泛型但可能具有不同的类型,我们可以使用多个泛型类型参数。例如,在示例 10-8 中,我们将 Point 的定义改为在类型 TU 上是泛型的,其中 x 是类型 Ty 是类型 U

Filename: src/main.rs
struct Point<T, U> {
    x: T,
    y: U,
}

fn main() {
    let both_integer = Point { x: 5, y: 10 };
    let both_float = Point { x: 1.0, y: 4.0 };
    let integer_and_float = Point { x: 5, y: 4.0 };
}
Listing 10-8: 一个在两种类型上泛型的 Point<T, U>,使得 xy 可以是不同类型的值

现在所示的所有 Point 实例都是允许的!你可以在定义中使用任意多个泛型类型参数,但使用多个会使你的代码难以阅读。如果你发现代码中需要大量泛型类型,可能表明你的代码需要重组为更小的部分。

在枚举定义中

与结构体一样,我们可以定义枚举在其变体中持有泛型数据类型。让我们再看一下标准库提供的 Option<T> 枚举,我们在第 6 章中使用过它:

#![allow(unused)]
fn main() {
enum Option<T> {
    Some(T),
    None,
}
}

这个定义现在对你来说应该更有意义了。如你所见,Option<T> 枚举在类型 T 上是泛型的,并且有两个变体:Some,它持有一个类型 T 的值,以及 None 变体,它不持有任何值。通过使用 Option<T> 枚举,我们可以表达可选值的抽象概念,并且因为 Option<T> 是泛型的,无论可选值的类型是什么,我们都可以使用这个抽象。

枚举也可以使用多个泛型类型。我们在第 9 章中使用的 Result 枚举的定义就是一个例子:

#![allow(unused)]
fn main() {
enum Result<T, E> {
    Ok(T),
    Err(E),
}
}

Result 枚举在两种类型 TE 上是泛型的,并且有两个变体:Ok,它持有一个类型 T 的值,以及 Err,它持有一个类型 E 的值。这个定义使得在有一个可能成功(返回某种类型 T 的值)或失败(返回某种类型 E 的错误)的操作的任何地方使用 Result 枚举都很方便。实际上,这就是我们在示例 9-3 中打开文件时使用的,其中 T 被填充为类型 std::fs::File(当文件成功打开时),而 E 被填充为类型 std::io::Error(当打开文件出现问题时)。

当你在代码中识别出多个结构体或枚举定义仅在它们持有的值类型上有所不同时,你可以通过使用泛型类型来避免重复。

在方法定义中

我们可以在结构体和枚举上实现方法(就像我们在第 5 章中所做的那样),并在它们的定义中使用泛型类型。示例 10-9 显示了我们之前在示例 10-6 中定义的 Point<T> 结构体,以及在它上面实现的名为 x 的方法。

Filename: src/main.rs
struct Point<T> {
    x: T,
    y: T,
}

impl<T> Point<T> {
    fn x(&self) -> &T {
        &self.x
    }
}

fn main() {
    let p = Point { x: 5, y: 10 };

    println!("p.x = {}", p.x());
}
Listing 10-9: 在 Point<T> 结构体上实现一个名为 x 的方法,该方法将返回对类型为 Tx 字段的引用

在这里,我们在 Point<T> 上定义了一个名为 x 的方法,它返回对字段 x 中数据的引用。

注意,我们必须在 impl 之后立即声明 T,以便我们可以使用 T 来指定我们正在为类型 Point<T> 实现方法。通过在 impl 之后将 T 声明为泛型类型,Rust 可以识别 Point 中尖括号内的类型是泛型类型而不是具体类型。我们可以为这个泛型参数选择与结构体定义中声明的泛型参数不同的名称,但使用相同的名称是惯例。如果你在声明了泛型类型的 impl 中编写方法,那么无论最终用哪种具体类型替换泛型类型,该方法都将在该类型的任何实例上定义。

我们也可以在定义类型上的方法时指定对泛型类型的约束。例如,我们可以仅在 Point<f32> 实例上实现方法,而不是在任何泛型类型的 Point<T> 实例上实现。在示例 10-10 中,我们使用了具体类型 f32,意味着我们在 impl 之后没有声明任何类型。

Filename: src/main.rs
struct Point<T> {
    x: T,
    y: T,
}

impl<T> Point<T> {
    fn x(&self) -> &T {
        &self.x
    }
}

impl Point<f32> {
    fn distance_from_origin(&self) -> f32 {
        (self.x.powi(2) + self.y.powi(2)).sqrt()
    }
}

fn main() {
    let p = Point { x: 5, y: 10 };

    println!("p.x = {}", p.x());
}
Listing 10-10: 一个仅适用于具有泛型类型参数 T 的特定具体类型的结构体的 impl

这段代码意味着类型 Point<f32> 将有一个 distance_from_origin 方法;其他 T 不是 f32 类型的 Point<T> 实例将没有此方法定义。该方法测量我们的点距离坐标 (0.0, 0.0) 处的点有多远,并使用仅适用于浮点类型的数学运算。

结构体定义中的泛型类型参数并不总是与你在此结构体的方法签名中使用的相同。示例 10-11 为 Point 结构体使用泛型类型 X1Y1,为 mixup 方法签名使用 X2Y2,以使示例更清晰。该方法创建一个新的 Point 实例,其 x 值来自 selfPoint(类型为 X1),y 值来自传入的 Point(类型为 Y2)。

Filename: src/main.rs
struct Point<X1, Y1> {
    x: X1,
    y: Y1,
}

impl<X1, Y1> Point<X1, Y1> {
    fn mixup<X2, Y2>(self, other: Point<X2, Y2>) -> Point<X1, Y2> {
        Point {
            x: self.x,
            y: other.y,
        }
    }
}

fn main() {
    let p1 = Point { x: 5, y: 10.4 };
    let p2 = Point { x: "Hello", y: 'c' };

    let p3 = p1.mixup(p2);

    println!("p3.x = {}, p3.y = {}", p3.x, p3.y);
}
Listing 10-11: 一个使用与其结构体定义不同的泛型类型的方法

main 中,我们定义了一个 Point,其 xi32(值为 5),yf64(值为 10.4)。p2 变量是一个 Point 结构体,其 x 为字符串切片(值为 "Hello"),ychar(值为 c)。在 p1 上调用 mixup 并传入参数 p2 得到 p3,其 x 将为 i32,因为 x 来自 p1p3 变量的 y 将为 char,因为 y 来自 p2println! 宏调用将打印 p3.x = 5, p3.y = c

此示例的目的是展示一种情况,其中一些泛型参数用 impl 声明,另一些用方法定义声明。在这里,泛型参数 X1Y1impl 之后声明,因为它们与结构体定义相关。泛型参数 X2Y2fn mixup 之后声明,因为它们仅与方法相关。

使用泛型的代码的性能

你可能想知道使用泛型类型参数是否会产生运行时开销。好消息是,使用泛型类型不会使你的程序比使用具体类型时运行得更慢。

Rust 通过在编译时对使用泛型的代码执行单态化(monomorphization)来实现这一点。*单态化(Monomorphization)*是通过填充编译时使用的具体类型,将泛型代码转换为特定代码的过程。在这个过程中,编译器执行与我们创建示例 10-5 中的泛型函数时使用的步骤相反的操作:编译器查看调用泛型代码的所有位置,并为调用泛型代码的具体类型生成代码。

让我们通过使用标准库的泛型 Option<T> 枚举来看看这是如何工作的:

#![allow(unused)]
fn main() {
let integer = Some(5);
let float = Some(5.0);
}

当 Rust 编译这段代码时,它会执行单态化。在这个过程中,编译器读取在 Option<T> 实例中使用的值,并识别出两种 Option<T>:一种是 i32,另一种是 f64。因此,它将 Option<T> 的泛型定义扩展为两个专门针对 i32f64 的定义,从而用特化的定义替换了泛型定义。

单态化后的代码版本类似于以下内容(编译器使用的名称与我们在这里用来说明问题的名称不同):

Filename: src/main.rs
enum Option_i32 {
    Some(i32),
    None,
}

enum Option_f64 {
    Some(f64),
    None,
}

fn main() {
    let integer = Option_i32::Some(5);
    let float = Option_f64::Some(5.0);
}

泛型 Option<T> 被替换为由编译器创建的特定定义。因为 Rust 将泛型代码编译为在每个实例中指定了类型的代码,所以使用泛型不会产生运行时开销。当代码运行时,它的执行方式与我们手动复制每个定义时完全相同。单态化过程使 Rust 的泛型在运行时极为高效。