泛型数据类型

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

在函数定义中

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

继续我们的 largest 函数,列表 10-4 显示了两个函数,它们都查找切片中的最大值。然后,我们将把它们组合成一个使用泛型的函数。

文件名: 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');
}

列表 10-4:两个函数仅在名称和签名中的类型方面有所不同

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

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

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

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

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

列表 10-5 显示了使用其签名中的泛型数据类型的组合 largest 函数定义。该列表还显示了我们如何使用 i32 值或 char 值的切片来调用该函数。请注意,此代码尚未编译,但我们将在本章稍后修复它。

文件名: 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}");
}

列表 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`
  |
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)。通过遵循帮助文本的建议,我们将 T 的有效类型限制为仅那些实现 PartialOrd 的类型,并且此示例将编译,因为标准库在 i32char 上都实现了 PartialOrd

在结构体定义中

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

文件名: 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 };
}

列表 10-6:一个 Point<T> 结构体,它保存类型为 Txy

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

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

文件名: src/main.rs

struct Point<T> {
    x: T,
    y: T,
}

fn main() {
    let wont_work = Point { x: 5, y: 4.0 };
}

列表 10-7:字段 xy 必须是相同的类型,因为它们都具有相同的泛型数据类型 T

在此示例中,当我们为 x 分配整数值 5 时,我们让编译器知道对于此 Point<T> 实例,泛型类型 T 将是一个整数。然后,当我们为 y 指定 4.0 时,我们定义 yx 具有相同的类型,我们会得到类似这样的类型不匹配错误

$ 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

文件名: 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 };
}

列表 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 的方法。

文件名: 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());
}

列表 10-9:在 Point<T> 结构体上实现一个名为 x 的方法,该方法将返回对类型 Tx 字段的引用

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

请注意,我们必须在 impl 之后声明 T,以便可以使用 T 来指定我们正在对类型 Point<T> 实现方法。通过在 impl 之后将 T 声明为泛型类型,Rust 可以识别 Point 中尖括号中的类型是泛型类型而不是具体类型。我们可以为此泛型参数选择与结构体定义中声明的泛型参数不同的名称,但是使用相同的名称是常规的。在声明泛型类型的 impl 中编写的方法将在类型的任何实例上定义,无论哪个具体类型最终替代泛型类型。

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

文件名: 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());
}

列表 10-10:一个 impl 代码块,仅适用于泛型类型参数 T 具有特定具体类型的结构体

此代码表示类型 Point<f32> 将具有 distance_from_origin 方法;T 的类型不是 f32Point<T> 的其他实例将不会定义此方法。该方法测量我们的点距离坐标 (0.0, 0.0) 处的点的距离,并使用仅适用于浮点类型的数学运算。

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

文件名: 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);
}

列表 10-11:一个使用与其结构体定义不同的泛型类型的方法

main 函数中,我们定义了一个 Point 结构体,它有一个 i32 类型的 x 字段(值为 5)和一个 f64 类型的 y 字段(值为 10.4)。 变量 p2 是一个 Point 结构体,它的 x 字段是一个字符串切片(值为 "Hello"),而 y 字段是一个 char 类型(值为 c)。 调用 p1mixup 方法,并传入参数 p2,得到 p3p3x 字段将是 i32 类型,因为 x 来自 p1p3y 字段将是 char 类型,因为 y 来自 p2println! 宏调用会打印 p3.x = 5, p3.y = c

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

使用泛型代码的性能

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

Rust 通过在编译时对使用泛型的代码执行单态化来实现这一点。单态化是将泛型代码转换为特定代码的过程,通过填充编译时使用的具体类型来实现。在这个过程中,编译器会执行我们在 Listing 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 的定义,从而将泛型定义替换为特定的定义。

代码的单态化版本类似于以下内容(编译器使用与我们在此处为说明目的所使用的名称不同的名称)

文件名: 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 的泛型在运行时非常高效。