附录 C：可派生 trait

在本书的各个地方，我们都讨论过 derive 属性，你可以将其应用于结构体或枚举定义。derive 属性会生成代码，这些代码将在你使用 derive 语法注释的类型上实现具有其自身默认实现的 trait。

在本附录中，我们提供了标准库中所有可以使用 derive 的 trait 的参考。每个部分涵盖：

  • 派生此 trait 将启用哪些运算符和方法
  • derive 提供的 trait 的实现做了什么
  • 实现 trait 对类型的意义
  • 允许或不允许实现 trait 的条件
  • 需要 trait 的操作示例

如果你希望获得与 derive 属性提供的行为不同的行为，请查阅每个 trait 的 标准库文档以获取有关如何手动实现它们的详细信息。

此处列出的 trait 是标准库定义的唯一可以使用 derive 在你的类型上实现的 trait。标准库中定义的其他 trait 没有合理的默认行为，因此你需要以对你要完成的任务有意义的方式来实现它们。

一个不能派生的 trait 的例子是 Display，它处理面向最终用户的格式化。你应该始终考虑将类型显示给最终用户的适当方式。最终用户应该被允许看到类型的哪些部分？他们会发现哪些部分是相关的？哪种数据格式与他们最相关？Rust 编译器没有这种洞察力，因此它无法为你提供适当的默认行为。

本附录中提供的可派生 trait 列表并不全面：库可以为自己的 trait 实现 derive，从而使你可以使用 derive 的 trait 列表真正地开放。实现 derive 涉及使用过程宏，这在第 19 章的 “宏”部分中进行了介绍。

Debug 用于程序员输出

Debug trait 启用格式字符串中的调试格式，你可以通过在 {} 占位符内添加 :? 来指示。

Debug trait 允许你打印类型的实例以进行调试，因此你和使用你的类型的其他程序员可以在程序执行的特定点检查实例。

例如，在使用 assert_eq! 宏时需要 Debug trait。如果相等断言失败，此宏将打印作为参数给定的实例的值，以便程序员可以查看为什么两个实例不相等。

PartialEq 和 Eq 用于相等性比较

PartialEq trait 允许你比较类型的实例以检查相等性，并启用 == 和 != 运算符的使用。

派生 PartialEq 会实现 eq 方法。当在结构体上派生 PartialEq 时，仅当*所有*字段都相等时，两个实例才相等，如果任何字段不相等，则实例不相等。当在枚举上派生时，每个变体都等于自身，而不等于其他变体。

例如，在使用 assert_eq! 宏时需要 PartialEq trait，该宏需要能够比较类型的两个实例是否相等。

Eq trait 没有方法。它的目的是表明对于注释类型的每个值，该值都等于自身。Eq trait 只能应用于也实现了 PartialEq 的类型，尽管并非所有实现了 PartialEq 的类型都可以实现 Eq。例如浮点数类型：浮点数的实现规定，非数字 (NaN) 值的两个实例彼此不相等。

需要 Eq 的一个示例是 HashMap<K, V> 中的键，因此 HashMap<K, V> 可以判断两个键是否相同。

PartialOrd 和 Ord 用于排序比较

PartialOrd trait 允许你比较类型的实例以进行排序。实现了 PartialOrd 的类型可以与 <、>、<= 和 >= 运算符一起使用。你只能将 PartialOrd trait 应用于也实现了 PartialEq 的类型。

派生 PartialOrd 会实现 partial_cmp 方法，该方法返回一个 Option<Ordering>，当给定的值没有产生排序时，该方法将返回 None。一个没有产生排序的值的例子是非数字 (NaN) 浮点值，即使该类型的大多数值都可以比较。使用任何浮点数和 NaN 浮点值调用 partial_cmp 将返回 None。

当在结构体上派生时，PartialOrd 通过比较每个字段中的值来比较两个实例，比较顺序为字段在结构体定义中出现的顺序。当在枚举上派生时，枚举定义中较早声明的枚举变体被认为小于后面列出的变体。

例如，rand crate 中的 gen_range 方法需要 PartialOrd trait，该方法用于在范围表达式指定的范围内生成随机值。

Ord trait 允许您确定对于带注释类型的任意两个值，都存在有效的排序。Ord trait 实现了 cmp 方法，该方法返回一个 Ordering 而不是 Option<Ordering>，因为始终可以进行有效的排序。您只能将 Ord trait 应用于也实现了 PartialOrd 和 Eq 的类型（而 Eq 需要 PartialEq）。当在结构体和枚举上派生时，cmp 的行为方式与 PartialOrd 的 partial_cmp 派生实现相同。

需要 Ord 的一个例子是在 BTreeSet<T> 中存储值时，这是一种根据值的排序顺序存储数据的数据结构。

Clone 和 Copy 用于复制值

Clone trait 允许您显式地创建值的深拷贝，并且复制过程可能涉及运行任意代码和复制堆数据。有关 Clone 的更多信息，请参阅第 4 章中的 “变量和数据交互的方式：Clone”部分。

派生 Clone 会实现 clone 方法，当为整个类型实现时，该方法会对类型的每个部分调用 clone。这意味着类型中的所有字段或值也必须实现 Clone 才能派生 Clone。

需要 Clone 的一个例子是在切片上调用 to_vec 方法时。切片不拥有它包含的类型实例，但是从 to_vec 返回的向量需要拥有它的实例，因此 to_vec 会对每个项目调用 clone。因此，存储在切片中的类型必须实现 Clone。

Copy trait 允许您仅通过复制存储在堆栈上的位来复制值；不需要任意代码。有关 Copy 的更多信息，请参阅第 4 章中的 “仅堆栈数据：Copy”部分。

Copy trait 没有定义任何方法来防止程序员重载这些方法并违反不运行任意代码的假设。这样，所有程序员都可以假设复制值将非常快。

您可以在任何其所有部分都实现 Copy 的类型上派生 Copy。实现 Copy 的类型也必须实现 Clone，因为实现 Copy 的类型具有 Clone 的简单实现，该实现执行与 Copy 相同的任务。

很少需要 Copy trait；实现 Copy 的类型可以使用优化，这意味着您不必调用 clone，这使得代码更加简洁。

使用 Copy 可以完成的所有操作，您也可以使用 Clone 完成，但代码可能会变慢，或者必须在某些地方使用 clone。

Hash 用于将值映射到固定大小的值

Hash trait 允许您获取任意大小的类型实例，并使用哈希函数将该实例映射到固定大小的值。派生 Hash 会实现 hash 方法。hash 方法的派生实现组合了对类型的每个部分调用 hash 的结果，这意味着所有字段或值也必须实现 Hash 才能派生 Hash。

需要 Hash 的一个例子是在 HashMap<K, V> 中存储键以有效地存储数据。

Default 用于默认值

Default trait 允许您为类型创建默认值。派生 Default 会实现 default 函数。default 函数的派生实现对类型的每个部分调用 default 函数，这意味着类型中的所有字段或值也必须实现 Default 才能派生 Default。

Default::default 函数通常与第 5 章 “使用结构体更新语法从其他实例创建实例”部分中讨论的结构体更新语法结合使用。您可以自定义结构体的几个字段，然后使用 ..Default::default() 为其余字段设置和使用默认值。

例如，当您在 Option<T> 实例上使用 unwrap_or_default 方法时，需要 Default trait。如果 Option<T> 为 None，则 unwrap_or_default 方法将返回 Option<T> 中存储的类型 T 的 Default::default 的结果。