gitbook/陈天 · Rust 编程第一课/docs/421324.md
2022-09-03 22:05:03 +08:00

35 KiB
Raw Permalink Blame History

14类型系统有哪些必须掌握的trait

你好,我是陈天。

开发软件系统时,我们弄清楚需求,要对需求进行架构上的分析和设计。在这个过程中,合理地定义和使用 trait会让代码结构具有很好的扩展性让系统变得非常灵活。

之前在 get hands dirty 系列中就粗略见识到了 trait 的巨大威力,使用了 From / TryFrom trait 进行类型间的转换(第 5 讲),还使用了 Deref trait 第 6 讲)让类型在不暴露其内部结构代码的同时,让内部结构的方法可以对外使用。

经过上两讲的学习相信你现在对trait 的理解就深入了。在实际解决问题的过程中,用好这些 trait会让你的代码结构更加清晰阅读和使用都更加符合 Rust 生态的习惯。比如数据结构实现了 Debug trait那么当你想打印数据结构时就可以用 {:?} 来打印;如果你的数据结构实现了 From那么可以直接使用 into() 方法做数据转换。

trait

Rust 语言的标准库定义了大量的标准 trait来先来数已经学过的看看攒了哪些

  • Clone / Copy trait约定了数据被深拷贝和浅拷贝的行为
  • Read / Write trait约定了对 I/O 读写的行为;
  • Iterator约定了迭代器的行为
  • Debug约定了数据如何被以 debug 的方式显示出来的行为;
  • Default约定数据类型的缺省值如何产生的行为
  • From / TryFrom约定了数据间如何转换的行为。

我们会再学习几类重要的 trait包括和内存分配释放相关的 trait、用于区别不同类型协助编译器做类型安全检查的标记 trait、进行类型转换的 trait、操作符相关的 trait以及 Debug/Display/Default。

在学习这些 trait的过程中你也可以结合之前讲的内容有意识地思考一下Rust为什么这么设计在增进对语言理解的同时也能写出更加优雅的 Rust 代码。

内存相关Clone / Copy / Drop

首先来看内存相关的 Clone/Copy/Drop。这三个 trait 在介绍所有权的时候已经学习过,这里我们再深入研究一下它们的定义和使用场景。

Clone trait

首先看 Clone

pub trait Clone {
  fn clone(&self) -> Self;

  fn clone_from(&mut self, source: &Self) {
    *self = source.clone()
  }
}

Clone trait 有两个方法, clone()clone_from() ,后者有缺省实现,所以平时我们只需要实现 clone() 方法即可。你也许会疑惑,这个 clone_from() 有什么作用呢?因为看起来 a.clone_from(&b) ,和 a = b.clone() 是等价的。

其实不是,如果 a 已经存在,在 clone 过程中会分配内存,那么a.clone_from(&b) 可以避免内存分配,提高效率

Clone trait 可以通过派生宏直接实现这样能简化不少代码。如果在你的数据结构里每一个字段都已经实现了Clone trait你可以用 #[derive(Clone)] ,看下面的代码,定义了 Developer 结构和 Language 枚举:

#[derive(Clone, Debug)]
struct Developer {
  name: String,
  age: u8,
  lang: Language
}

#[allow(dead_code)]
#[derive(Clone, Debug)]
enum Language {
  Rust,
  TypeScript,
  Elixir,
  Haskell
}

fn main() {
    let dev = Developer {
        name: "Tyr".to_string(),
        age: 18,
        lang: Language::Rust
    };
    let dev1 = dev.clone();
    println!("dev: {:?}, addr of dev name: {:p}", dev, dev.name.as_str());
    println!("dev1: {:?}, addr of dev1 name: {:p}", dev1, dev1.name.as_str())
}

如果没有为 Language 实现 Clone 的话Developer 的派生宏 Clone 将会编译出错。运行这段代码可以看到,对于 name也就是 String 类型的 Clone其堆上的内存也被 Clone 了一份,所以 Clone 是深度拷贝,栈内存和堆内存一起拷贝。

值得注意的是clone 方法的接口是 &self这在绝大多数场合下都是适用的我们在 clone 一个数据时只需要有已有数据的只读引用。但对 Rc 这样在 clone() 时维护引用计数的数据结构clone() 过程中会改变自己,所以要用 Cell 这样提供内部可变性的结构来进行改变,如果你也有类似的需求,可以参考。

Copy trait

和 Clone trait 不同的是Copy trait 没有任何额外的方法,它只是一个标记 traitmarker trait。它的 trait 定义:

pub trait Copy: Clone {}

所以看这个定义,如果要实现 Copy trait 的话,必须实现 Clone trait然后实现一个空的 Copy trait。你是不是有点疑惑这样不包含任何行为的 trait 有什么用呢?

这样的 trait 虽然没有任何行为,但它可以用作 trait bound 来进行类型安全检查,所以我们管它叫标记 trait

和 Clone 一样,如果数据结构的所有字段都实现了 Copy也可以用 #[derive(Copy)] 宏来为数据结构实现 Copy。试着为 Developer 和 Language 加上 Copy

#[derive(Clone, Copy, Debug)]
struct Developer {
  name: String,
  age: u8,
  lang: Language
}

#[derive(Clone, Copy, Debug)]
enum Language {
  Rust,
  TypeScript,
  Elixir,
  Haskell
}

这个代码会出错。因为 String 类型没有实现 Copy。 因此Developer 数据结构只能 clone无法 copy。我们知道如果类型实现了 Copy那么在赋值、函数调用的时候值会被拷贝否则所有权会被移动。

所以上面的代码 Developer 类型在做参数传递时,会执行 Move 语义,而 Language 会执行 Copy 语义。

在讲所有权可变/不可变引用的时候提到,不可变引用实现了 Copy而可变引用 &mut T 没有实现 Copy。为什么是这样

因为如果可变引用实现了 Copy trait那么生成一个可变引用然后把它赋值给另一个变量时就会违背所有权规则同一个作用域下只能有一个可变引用。可见Rust 标准库在哪些结构可以 Copy、哪些不可以 Copy 上,有着仔细的考量。

Drop trait

在内存管理中已经详细探讨过 Drop trait。这里我们再看一下它的定义

pub trait Drop {
    fn drop(&mut self);
}

大部分场景无需为数据结构提供 Drop trait系统默认会依次对数据结构的每个域做 drop。但有两种情况你可能需要手工实现 Drop。

第一种是希望在数据结束生命周期的时候做一些事情,比如记日志。

第二种是需要对资源回收的场景。编译器并不知道你额外使用了哪些资源,也就无法帮助你 drop 它们。比如说锁资源的释放,在 MutexGuard 中实现了 Drop 来释放锁资源:

impl<T: ?Sized> Drop for MutexGuard<'_, T> {
    #[inline]
    fn drop(&mut self) {
        unsafe {
            self.lock.poison.done(&self.poison);
            self.lock.inner.raw_unlock();
        }
    }
}

需要注意的是Copy trait 和 Drop trait 是互斥的,两者不能共存,当你尝试为同一种数据类型实现 Copy 时,也实现 Drop编译器就会报错。这其实很好理解Copy是按位做浅拷贝那么它会默认拷贝的数据没有需要释放的资源而Drop恰恰是为了释放额外的资源而生的

我们还是写一段代码来辅助理解,在代码中,强行用 Box::into_raw 获得堆内存的指针,放入 RawBuffer 结构中,这样就接管了这块堆内存的释放。

虽然 RawBuffer 可以实现 Copy trait但这样一来就无法实现 Drop trait。如果程序非要这么写会导致内存泄漏因为该释放的堆内存没有释放。

但是这个操作不会破坏 Rust 的正确性保证:即便你 Copy 了 N 份 RawBuffer由于无法实现 Drop traitRawBuffer 指向的那同一块堆内存不会释放,所以不会出现 use after free 的内存安全问题。(代码

use std::{fmt, slice};

// 注意这里,我们实现了 Copy这是因为 *mut u8/usize 都支持 Copy
#[derive(Clone, Copy)]
struct RawBuffer {
    // 裸指针用 *const / *mut 来表述,这和引用的 & 不同
    ptr: *mut u8,
    len: usize,
}

impl From<Vec<u8>> for RawBuffer {
    fn from(vec: Vec<u8>) -> Self {
        let slice = vec.into_boxed_slice();
        Self {
            len: slice.len(),
            // into_raw 之后Box 就不管这块内存的释放了RawBuffer 需要处理释放
            ptr: Box::into_raw(slice) as *mut u8,
        }
    }
}

// 如果 RawBuffer 实现了 Drop trait就可以在所有者退出时释放堆内存
// 然后Drop trait 会跟 Copy trait 冲突,要么不实现 Copy要么不实现 Drop
// 如果不实现 Drop那么就会导致内存泄漏但它不会对正确性有任何破坏
// 比如不会出现 use after free 这样的问题。
// 你可以试着把下面注释去掉,看看会出什么问题
// impl Drop for RawBuffer {
//     #[inline]
//     fn drop(&mut self) {
//         let data = unsafe { Box::from_raw(slice::from_raw_parts_mut(self.ptr, self.len)) };
//         drop(data)
//     }
// }

impl fmt::Debug for RawBuffer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let data = self.as_ref();
        write!(f, "{:p}: {:?}", self.ptr, data)
    }
}

impl AsRef<[u8]> for RawBuffer {
    fn as_ref(&self) -> &[u8] {
        unsafe { slice::from_raw_parts(self.ptr, self.len) }
    }
}

fn main() {
    let data = vec![1, 2, 3, 4];

    let buf: RawBuffer = data.into();

    // 因为 buf 允许 Copy所以这里 Copy 了一份
    use_buffer(buf);

    // buf 还能用
    println!("buf: {:?}", buf);
}

fn use_buffer(buf: RawBuffer) {
    println!("buf to die: {:?}", buf);

    // 这里不用特意 drop写出来只是为了说明 Copy 出来的 buf 被 Drop 了
    drop(buf)
}

对于代码安全来说,内存泄漏危害大?还是 use after free 危害大呢肯定是后者。Rust 的底线是内存安全,所以两害相权取其轻。

实际上,任何编程语言都无法保证不发生人为的内存泄漏,比如程序在运行时,开发者疏忽了,对哈希表只添加不删除,就会造成内存泄漏。但 Rust 会保证即使开发者疏忽了,也不会出现内存安全问题。

建议你仔细阅读这段代码中的注释,试着把注释掉的 Drop trait 恢复,然后再把代码改得可以编译通过,认真思考一下 Rust 这样做的良苦用心。

标记 traitSized / Send / Sync / Unpin

好,讲完内存相关的主要 trait来看标记 trait。

刚才我们已经看到了一个标记 traitCopy。Rust 还支持其它几种标记 traitSized / Send / Sync / Unpin

Sized trait 用于标记有具体大小的类型。在使用泛型参数时Rust 编译器会自动为泛型参数加上 Sized 约束,比如下面的 Data 和处理 Data 的函数 process_data

struct Data<T> {
    inner: T,
}

fn process_data<T>(data: Data<T>) {
    todo!();
}

它等价于:

struct Data<T: Sized> {
    inner: T,
}

fn process_data<T: Sized>(data: Data<T>) {
    todo!();
}

大部分时候我们都希望能自动添加这样的约束因为这样定义出的泛型结构在编译期大小是固定的可以作为参数传递给函数。如果没有这个约束T 是大小不固定的类型, process_data 函数会无法编译。

但是这个自动添加的约束有时候不太适用,在少数情况下,需要 T 是可变类型的怎么办Rust 提供了 ?Sized 来摆脱这个约束

如果开发者显式定义了T: ?Sized,那么 T 就可以是任意大小。如果你对(第12讲)之前说的 Cow 还有印象,可能会记得 Cow 中泛型参数 B 的约束是 ?Sized

pub enum Cow<'a, B: ?Sized + 'a> where B: ToOwned,
{
    // 借用的数据
    Borrowed(&'a B),
    // 拥有的数据
    Owned(<B as ToOwned>::Owned),
}

这样 B 就可以是 [T] 或者 str 类型,大小都是不固定的。要注意 Borrowed(&'a B) 大小是固定的,因为它内部是对 B 的一个引用,而引用的大小是固定的。

Send / Sync

说完了 Sized我们再来看 Send / Sync定义是

pub unsafe auto trait Send {}
pub unsafe auto trait Sync {}

这两个 trait 都是 unsafe auto traitauto 意味着编译器会在合适的场合,自动为数据结构添加它们的实现,而 unsafe 代表实现的这个 trait 可能会违背 Rust 的内存安全准则,如果开发者手工实现这两个 trait ,要自己为它们的安全性负责。

Send/Sync 是 Rust 并发安全的基础:

  • 如果一个类型 T 实现了 Send trait意味着 T 可以安全地从一个线程移动到另一个线程,也就是说所有权可以在线程间移动。
  • 如果一个类型 T 实现了 Sync trait则意味着 &T 可以安全地在多个线程中共享。一个类型 T 满足 Sync trait当且仅当 &T 满足 Send trait。

对于 Send/Sync 在线程安全中的作用,可以这么看,如果一个类型T: Send那么 T 在某个线程中的独占访问是线程安全的;如果一个类型 T: Sync那么 T 在线程间的只读共享是安全的

对于我们自己定义的数据结构,如果其内部的所有域都实现了 Send / Sync那么这个数据结构会被自动添加 Send / Sync 。基本上原生数据结构都支持 Send / Sync也就是说绝大多数自定义的数据结构都是满足 Send / Sync 的。标准库中,不支持 Send / Sync 的数据结构主要有:

  • 裸指针 *const T / *mut T。它们是不安全的所以既不是 Send 也不是 Sync。
  • UnsafeCell 不支持 Sync。也就是说任何使用了 Cell 或者 RefCell 的数据结构不支持 Sync。
  • 引用计数 Rc 不支持 Send 也不支持 Sync。所以 Rc 无法跨线程。

之前介绍过 Rc / RefCell第9讲),我们来看看,如果尝试跨线程使用 Rc / RefCell会发生什么。在 Rust 下,如果想创建一个新的线程,需要使用 std:🧵:spawn

pub fn spawn<F, T>(f: F) -> JoinHandle<T> 
where
    F: FnOnce() -> T,
    F: Send + 'static,
    T: Send + 'static,

它的参数是一个闭包(后面会讲),这个闭包需要 Send + 'static

  • 'static 意思是闭包捕获的自由变量必须是一个拥有所有权的类型,或者是一个拥有静态生命周期的引用;
  • Send 意思是,这些被捕获自由变量的所有权可以从一个线程移动到另一个线程。

从这个接口上,可以得出结论:如果在线程间传递 Rc是无法编译通过的因为 Rc 的实现不支持 Send 和 Sync。写段代码验证一下(代码

// Rc 既不是 Send也不是 Sync
fn rc_is_not_send_and_sync() {
    let a = Rc::new(1);
    let b = a.clone();
    let c = a.clone();
    thread::spawn(move || {
        println!("c= {:?}", c);
    });
}

果然,这段代码不通过。

那么RefCell 可以在线程间转移所有权么?RefCell 实现了 Send但没有实现 Sync,所以,看起来是可以工作的(代码

fn refcell_is_send() {
    let a = RefCell::new(1);
    thread::spawn(move || {
        println!("a= {:?}", a);
    });
}

验证一下发现,这是 OK 的。

既然 Rc 不能 Send我们无法跨线程使用 Rc<RefCell> 这样的数据,那么使用支持 Send/Sync 的 Arc呢,使用 Arc<RefCell> 来获得,一个可以在多线程间共享,且可以修改的类型,可以么(代码

// RefCell 现在有多个 Arc 持有它,虽然 Arc 是 Send/Sync但 RefCell 不是 Sync
fn refcell_is_not_sync() {
    let a = Arc::new(RefCell::new(1));
    let b = a.clone();
    let c = a.clone();
    thread::spawn(move || {
        println!("c= {:?}", c);
    });
}

不可以。

因为 Arc 内部的数据是共享的,需要支持 Sync 的数据结构但是RefCell 不是 Sync编译失败。所以在多线程情况下我们只能使用支持 Send/Sync 的 Arc ,和 Mutex 一起,构造一个可以在多线程间共享且可以修改的类型(代码

use std::{
    sync::{Arc, Mutex},
    thread,
};

// Arc<Mutex<T>> 可以多线程共享且修改数据
fn arc_mutext_is_send_sync() {
    let a = Arc::new(Mutex::new(1));
    let b = a.clone();
    let c = a.clone();
    let handle = thread::spawn(move || {
        let mut g = c.lock().unwrap();
        *g += 1;
    });

    {
        let mut g = b.lock().unwrap();
        *g += 1;
    }

    handle.join().unwrap();
    println!("a= {:?}", a);
}

fn main() {
    arc_mutext_is_send_sync();
}

这几段代码建议你都好好阅读和运行一下,对于编译出错的情况,仔细看看编译器给出的错误,会帮助你理解好 Send/Sync trait 以及它们如何保证并发安全。

最后一个标记 trait Unpin是用于自引用类型的在后面讲到 Future trait 时,再详细讲这个 trait。

类型转换相关From / Into/AsRef / AsMut

好,学完了标记 trait来看看和类型转换相关的 trait。在软件开发的过程中我们经常需要在某个上下文中把一种数据结构转换成另一种数据结构。

不过转换有很多方式,看下面的代码,你觉得哪种方式更好呢?

// 第一种方法,为每一种转换提供一个方法
// 把字符串 s 转换成 Path
let v = s.to_path();
// 把字符串 s 转换成 u64
let v = s.to_u64();

// 第二种方法,为 s 和要转换的类型之间实现一个 Into<T> trait
// v 的类型根据上下文得出
let v = s.into();
// 或者也可以显式地标注 v 的类型
let v: u64 = s.into();

第一种方式,在类型 T 的实现里,要为每一种可能的转换提供一个方法;第二种,我们为类型 T 和类型 U 之间的转换实现一个数据转换 trait这样可以用同一个方法来实现不同的转换。

显然第二种方法要更好因为它符合软件开发的开闭原则Open-Close Principle软件中的对象(类、模块、函数等等)对扩展是开放的,但是对修改是封闭的”。

在第一种方式下,未来每次要添加对新类型的转换,都要重新修改类型 T 的实现,而第二种方式,我们只需要添加一个对于数据转换 trait 的新实现即可。

基于这个思路对值类型的转换和对引用类型的转换Rust 提供了两套不同的 trait

  • 值类型到值类型的转换From / Into / TryFrom / TryInto
  • 引用类型到引用类型的转换AsRef / AsMut

From / Into

先看 FromInto。这两个 trait 的定义如下:

pub trait From<T> {
    fn from(T) -> Self;
}

pub trait Into<T> {
    fn into(self) -> T;
}

在实现 From 的时候会自动实现 Into。这是因为

// 实现 From 会自动实现 Into
impl<T, U> Into<U> for T where U: From<T> {
    fn into(self) -> U {
        U::from(self)
    }
}

所以大部分情况下,只用实现 From然后这两种方式都能做数据转换比如

let s = String::from("Hello world!");
let s: String = "Hello world!".into();

这两种方式是等价的怎么选呢From 可以根据上下文做类型推导,使用场景更多;而且因为实现了 From 会自动实现 Into反之不会。所以需要的时候,不要去实现 Into只要实现 From 就好了

此外From 和 Into 还是自反的:把类型 T 的值转换成类型 T会直接返回。这是因为标准库有如下的实现

// From以及 Into是自反的
impl<T> From<T> for T {
    fn from(t: T) -> T {
        t
    }
}

有了 From 和 Into很多函数的接口就可以变得灵活比如函数如果接受一个 IpAddr 为参数,我们可以使用 Into 让更多的类型可以被这个函数使用,看下面的代码

use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};

fn print(v: impl Into<IpAddr>) {
    println!("{:?}", v.into());
}

fn main() {
    let v4: Ipv4Addr = "2.2.2.2".parse().unwrap();
    let v6: Ipv6Addr = "::1".parse().unwrap();
    
    // IPAddr 实现了 From<[u8; 4],转换 IPv4 地址
    print([1, 1, 1, 1]);
    // IPAddr 实现了 From<[u16; 8],转换 IPv6 地址
    print([0xfe80, 0, 0, 0, 0xaede, 0x48ff, 0xfe00, 0x1122]);
    // IPAddr 实现了 From<Ipv4Addr>
    print(v4);
    // IPAddr 实现了 From<Ipv6Addr>
    print(v6);
}

所以,合理地使用 From / Into可以让代码变得简洁符合 Rust 可读性强的风格,更符合开闭原则。

注意,如果你的数据类型在转换过程中有可能出现错误,可以使用 TryFromTryInto,它们的用法和 From / Into 一样,只是 trait 内多了一个关联类型 Error且返回的结果是 Result<T, Self::Error>。

AsRef / AsMut

搞明白了 From / Into 后AsRef 和 AsMut 就很好理解了,用于从引用到引用的转换。还是先看它们的定义:

pub trait AsRef<T> where T: ?Sized {
    fn as_ref(&self) -> &T;
}

pub trait AsMut<T> where T: ?Sized {
    fn as_mut(&mut self) -> &mut T;
}

在 trait 的定义上,都允许 T 使用大小可变的类型,如 str、[u8] 等。AsMut 除了使用可变引用生成可变引用外,其它都和 AsRef 一样,所以我们重点看 AsRef。

看标准库中打开文件的接口 std::fs::File::open

pub fn open<P: AsRef<Path>>(path: P) -> Result<File>

它的参数 path 是符合 AsRef 的类型,所以,你可以为这个参数传入 String、&str、PathBuf、Path 等类型。而且,当你使用 path.as_ref() 时,会得到一个 &Path。

来写一段代码体验一下 AsRef 的使用和实现(代码

#[allow(dead_code)]
enum Language {
    Rust,
    TypeScript,
    Elixir,
    Haskell,
}

impl AsRef<str> for Language {
    fn as_ref(&self) -> &str {
        match self {
            Language::Rust => "Rust",
            Language::TypeScript => "TypeScript",
            Language::Elixir => "Elixir",
            Language::Haskell => "Haskell",
        }
    }
}

fn print_ref(v: impl AsRef<str>) {
    println!("{}", v.as_ref());
}

fn main() {
    let lang = Language::Rust;
    // &str 实现了 AsRef<str>
    print_ref("Hello world!");
    // String 实现了 AsRef<str>
    print_ref("Hello world!".to_string());
    // 我们自己定义的 enum 也实现了 AsRef<str>
    print_ref(lang);
}

现在对在 Rust 下,如何使用 From / Into / AsRef / AsMut 进行类型间转换,有了深入了解,未来我们还会在实战中使用到这些 trait。

刚才的小例子中要额外说明一下的是,如果你的代码出现 v.as_ref().clone() 这样的语句,也就是说你要对 v 进行引用转换,然后又得到了拥有所有权的值,那么你应该实现 From然后做 v.into()。

操作符相关Deref / DerefMut

操作符相关的 trait ,上一讲我们已经看到了 Add trait它允许你重载加法运算符。Rust 为所有的运算符都提供了 trait你可以为自己的类型重载某些操作符。这里用下图简单概括一下更详细的信息你可以阅读官方文档

今天重点要介绍的操作符是 DerefDerefMut。来看它们的定义:

pub trait Deref {
    // 解引用出来的结果类型
    type Target: ?Sized;
    fn deref(&self) -> &Self::Target;
}

pub trait DerefMut: Deref {
    fn deref_mut(&mut self) -> &mut Self::Target;
}

可以看到DerefMut “继承”了 Deref只是它额外提供了一个 deref_mut 方法,用来获取可变的解引用。所以这里重点学习 Deref。

对于普通的引用,解引用很直观,因为它只有一个指向值的地址,从这个地址可以获取到所需要的值,比如下面的例子:

let mut x = 42;
let y = &mut x;
// 解引用,内部调用 DerefMut其实现就是 *self
*y += 1;

但对智能指针来说,拿什么域来解引用就不那么直观了,我们来看之前学过的 Rc 是怎么实现 Deref 的:

impl<T: ?Sized> Deref for Rc<T> {
    type Target = T;

    fn deref(&self) -> &T {
        &self.inner().value
    }
}

可以看到,它最终指向了堆上的 RcBox 内部的 value 的地址,然后如果对其解引用的话,得到了 value 对应的值。以下图为例,最终打印出 v = 1。

从图中还可以看到Deref 和 DerefMut 是自动调用的,*b 会被展开为 *(b.deref())。

在 Rust 里,绝大多数智能指针都实现了 Deref我们也可以为自己的数据结构实现 Deref。看一个例子代码

use std::ops::{Deref, DerefMut};

#[derive(Debug)]
struct Buffer<T>(Vec<T>);

impl<T> Buffer<T> {
    pub fn new(v: impl Into<Vec<T>>) -> Self {
        Self(v.into())
    }
}

impl<T> Deref for Buffer<T> {
    type Target = [T];

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for Buffer<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

fn main() {
    let mut buf = Buffer::new([1, 3, 2, 4]);
    // 因为实现了 Deref 和 DerefMut这里 buf 可以直接访问 Vec<T> 的方法
    // 下面这句相当于:(&mut buf).deref_mut().sort(),也就是 (&mut buf.0).sort()
    buf.sort();
    println!("buf: {:?}", buf);
}

但是在这个例子里,数据结构 Buffer 包裹住了 Vec但这样一来原本 Vec 实现了的很多方法,现在使用起来就很不方便,需要用 buf.0 来访问。怎么办?

可以实现 Deref 和 DerefMut这样在解引用的时候直接访问到 buf.0,省去了代码的啰嗦和数据结构内部字段的隐藏。

在这段代码里,还有一个值得注意的地方:写 buf.sort() 的时候,并没有做解引用的操作,为什么会相当于访问了 buf.0.sort() 呢?这是因为 sort() 方法第一个参数是 &mut self此时 Rust 编译器会强制做 Deref/DerefMut 的解引用,所以这相当于 (*(&mut buf)).sort()。

其它Debug / Display / Default

现在我们对运算符相关的 trait 有了足够的了解,最后来看看其它一些常用的 traitDebug / Display / Default

先看 Debug / Display它们的定义如下

pub trait Debug {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>;
}

pub trait Display {
    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>;
}

可以看到Debug 和 Display 两个 trait 的签名一样,都接受一个 &self 和一个 &mut Formatter。那为什么要有两个一样的 trait 呢?

这是因为 Debug 是为开发者调试打印数据结构所设计的,而 Display 是给用户显示数据结构所设计的。这也是为什么 Debug trait 的实现可以通过派生宏直接生成,而 Display 必须手工实现。在使用的时候Debug 用 {:?} 来打印Display 用 {} 打印。

最后看 Default trait。它的定义如下

pub trait Default {
    fn default() -> Self;
}

Default trait 用于为类型提供缺省值。它也可以通过 derive 宏 #[derive(Default)] 来生成实现,前提是类型中的每个字段都实现了 Default trait。在初始化一个数据结构时我们可以部分初始化然后剩余的部分使用 Default::default()。

Debug/Display/Default 如何使用,统一看个例子(代码

use std::fmt;
// struct 可以 derive Default但我们需要所有字段都实现了 Default
#[derive(Clone, Debug, Default)]
struct Developer {
    name: String,
    age: u8,
    lang: Language,
}

// enum 不能 derive Default
#[allow(dead_code)]
#[derive(Clone, Debug)]
enum Language {
    Rust,
    TypeScript,
    Elixir,
    Haskell,
}

// 手工实现 Default
impl Default for Language {
    fn default() -> Self {
        Language::Rust
    }
}

impl Developer {
    pub fn new(name: &str) -> Self {
        // 用 ..Default::default() 为剩余字段使用缺省值
        Self {
            name: name.to_owned(),
            ..Default::default()
        }
    }
}

impl fmt::Display for Developer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}({} years old): {:?} developer",
            self.name, self.age, self.lang
        )
    }
}

fn main() {
    // 使用 T::default()
    let dev1 = Developer::default();
    // 使用 Default::default(),但此时类型无法通过上下文推断,需要提供类型
    let dev2: Developer = Default::default();
    // 使用 T::new
    let dev3 = Developer::new("Tyr");
    println!("dev1: {}\\ndev2: {}\\ndev3: {:?}", dev1, dev2, dev3);
}

它们实现起来非常简单,你可以看文中的代码。

小结

今天介绍了内存管理、类型转换、操作符、数据显示等相关的基本 trait还介绍了标记 trait它是一种特殊的 trait主要是用于协助编译器检查类型安全。

在我们使用 Rust 开发时trait 占据了非常核心的地位。一个设计良好的 trait 可以大大提升整个系统的可用性和扩展性

很多优秀的第三方库,都围绕着 trait 展开它们的能力,比如上一讲提到的 tower-service 中的 Service trait,再比如你日后可能会经常使用到的 parser combinator 库 nomParser trait

因为 trait 实现了延迟绑定。不知道你是否还记得,之前串讲编程基础概念的时候,就谈到了延迟绑定。在软件开发中,延迟绑定会带来极大的灵活性。

从数据的角度看,数据结构是具体数据的延迟绑定,泛型结构是具体数据结构的延迟绑定;从代码的角度看,函数是一组实现某个功能的表达式的延迟绑定,泛型函数是函数的延迟绑定。那么 trait 是什么的延迟绑定呢?

trait 是行为的延迟绑定。我们可以在不知道具体要处理什么数据结构的前提下,先通过 trait 把系统的很多行为约定好。这也是为什么开头解释标准trait时频繁用到了“约定……行为”。

相信通过今天的学习,你能对 trait 有更深刻的认识,在撰写自己的数据类型时,就能根据需要实现这些 trait。

思考题

1.Vec 可以实现 Copy trait 么?为什么?
2.在使用 Arc<Mutex> 时,为什么下面这段代码可以直接使用 shared.lock()

use std::sync::{Arc, Mutex};
let shared = Arc::new(Mutex::new(1));
let mut g = shared.lock().unwrap();
*g += 1;

3.有余力的同学可以尝试一下,为下面的 List 类型实现 Index使得所有的测试都能通过。这段代码使用了 std::collections::LinkedList你可以参考官方文档阅读它支持的方法(代码

use std::{
    collections::LinkedList,
    ops::{Deref, DerefMut, Index},
};
struct List<T>(LinkedList<T>);

impl<T> Deref for List<T> {
    type Target = LinkedList<T>;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

impl<T> DerefMut for List<T> {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl<T> Default for List<T> {
    fn default() -> Self {
        Self(Default::default())
    }
}

impl<T> Index<isize> for List<T> {
    type Output = T;

    fn index(&self, index: isize) -> &Self::Output {
        todo!();
    }
}

#[test]
fn it_works() {
    let mut list: List<u32> = List::default();
    for i in 0..16 {
        list.push_back(i);
    }

    assert_eq!(list[0], 0);
    assert_eq!(list[5], 5);
    assert_eq!(list[15], 15);
    assert_eq!(list[16], 0);
    assert_eq!(list[-1], 15);
    assert_eq!(list[128], 0);
    assert_eq!(list[-128], 0);
}

今天你已经完成了Rust学习的第14次打卡坚持学习如果你觉得有收获也欢迎分享给身边的朋友邀TA一起讨论。我们下节课见