:::info 本章内容改编自《Programming Rust, 2nd Edition》的第9章。 ::: Struct是一种用户自定义的复合数据类型。这里,“复合”指的是,用户可以把若干具有不同或相同类型的值按照某种顺序排列在一起,形成一个复合的值。给定一个Struct类型的值,我们可以通过特定的方式访问到其中包含的某一个分量。Rust中的Struct还具有一个重要特点,即:可以把方法附着到一个Struct类型的值上。
Rust中的Struct,可以大致对应到C/C++中的Struct、Python中的Class、以及JavaScript中的Object。当然,这仅仅是一种大致对应,在细节上仍然存在很多差异。

三种形式的Struct

Rust中的Struct具有三种不同的形式。下面,我们逐个说明。

Named-Field Struct (NFS)

在一个NFS中,每一个分量都具有一个名称。分量的名称由用户在定义一个NFS时指定。给定一个NFS类型的值v,可以通过分量的名称访问对应分量的值。例如,v.name可以访问到v中名称为name的分量的值。

  1. struct ColorImage {
  2. size: (usize, usize),
  3. pixels: Vec<u32>
  4. }
  5. // 上面三行行代码定义/声明了一个NFS类型,名称为ColorImage
  6. // 该类型包含了两个分量,名称分别为size和pixels,类型分别为(usize, usize)和Vec<u32>
  7. fn main() {
  8. let width = 1024;
  9. let height = 768;
  10. let image = ColorImage {
  11. pixels: vec![0; width * height],
  12. size: (width, height)
  13. };
  14. // 上面三行代码创建了ColorImage的一个实例,并将其赋给变量image
  15. // 熟悉JavaScript的的同学,在看到这段代码后,一定有一种似曾相识的感觉
  16. // 这TMD不就是JavaScript中的Object Literal(对象字面量)吗!确实如此。
  17. // 我们在对类型检查最松散的JavaScript中和对类型检查异常严格的Rust中看到了一丝的共性
  18. // 其实这也不奇怪,因为这两种语言都与Mozilla有扯不开的关系
  19. // 仿照JavaScript中的命名方式,可以将这种声明Struct类型实例的方式称为Struct Literal
  20. println!("{:?}", image.size); //=> (1024, 768)
  21. println!("{}", image.pixels[0]); //=> 0
  22. // 上面两行展示了如何通过点操作符和分量名称,访问ColorImage实例中包含的某个分量
  23. }
  24. fn new_image(size: (usize, usize), pixels: Vec<u32>) -> ColorImage {
  25. assert_eq!(size.0 * size.1, pixels.len());
  26. ColorImage { size, pixels }
  27. // 上一行代码等价于 ColorImage { size: size, pixels: pixels }
  28. // 这是一种语法糖
  29. // 有时候,我望着这样的语法糖,竟然有些分不清Rust和JavaScript了呢!
  30. }

另外,上面程序也展示了Rust中关于标识符的一种命名习惯:

  • 对于表示类型的标识符,通常采用CamelCase的方式进行命名;
  • 对于表示变量、方法、分量名称的标识符,通常采用snake_case的方式进行命名。

在前面的章节中,我们已经看到了许多NFS的实例。其中需要注意的一个方面是:

  • 我们在声明一个NFS类型时,可以为每一个分量指定不同的可见性;
  • 若不指定,则一个分量缺省具有private的可见性。可见性在前文中已经介绍,此处不再赘述。

    Partially Moved Struct

    Struct这种复合类型的值,有一个重要的行为特点:可以将这个值的某一个分量的所有权转移给其它变量,进而得到一个partially-moved struct value。 ```rust fn main() { let monkey_king = Demon { name: String::from(“孙悟空”), age : 10000, addr: String::from(“花果山”) };

    println!(“{:?}”, monkey_king); //=> Demon { name: “孙悟空”, age: 10000, addr: “花果山” }

    let name = monkey_king.name; // value partially moved here // 上一行代码将monkey_king的分量name的所有权转移给了变量name // 这时,monkey_king就变成了一个partially moved struct

    println!(“{}”, name); //=> 孙悟空 println!(“{}”, monkey_king.age); //=> 10000 // 对于一个partially moved的struct,那些没有发生所有权转移的分量仍然可以正常访问

    println!(“{:?}”, monkey_king); // Compilation Error: borrow of partially moved value: monkey_king // 一个partially moved的struct,无法再创建对它的引用 // 另外,一个partially moved的struct,其自身的所有权也无法被转移给其他变量 }

[derive(Debug)]

struct Demon { name: String, age : u32, addr: String }

  1. <a name="oRAfU"></a>
  2. #### 分量缺省值
  3. 在创建一个NFS类型的值时,经常会遇到这种情况:我们只需要给这个值中的若干个分量赋予特定的值;其他分量则从另一个同类型的NFS值中读取。<br />Rust提供了一种针对这种情况的简便语法,即:在一个Struct Literal最后一个分量赋值之后,添加一个逗号`,`,后面书写一个`..`操作符,其后再书写一个同类型NFS表达式`EXPR`。此时,这个Struct Literal中未声明的分量,会从`EXPR`中获得同名分量的值。
  4. ```rust
  5. #[derive(Debug)]
  6. struct Demon {
  7. name: String,
  8. age : u32,
  9. addr: String
  10. }
  11. // 这个split函数的功能是把一个demon(精灵)一分为二,返回两个分裂后形成的精灵
  12. // 从该函数的参数类型可知,传入该函数的参数的所有权被转移到了函数内部
  13. fn split(demon: Demon) -> (Demon, Demon) {
  14. let mut d1 = Demon { age: demon.age / 2, .. demon };
  15. // 上一行代码创建了一个分裂后的精灵
  16. // 我们可以将其中的..demon理解为一种语法糖
  17. // 如果不使用这种语法糖,则上述Struct Literal必须被写为
  18. // Demon { age: demon.age/2, name: demon.name, addr: demo.addr }。
  19. // 显然可知,执行完这行代码后,demo变成了一个partially moved struct
  20. // 因为它的两个分量name和addr的所有权已经被转移给了新创建的精灵变量d1
  21. let mut d2 = Demon { name: d1.name.clone(),
  22. addr: d1.addr.clone(), .. d1 };
  23. // 上两行代码创建了另一个分裂后的精灵
  24. // 这里需要注意:为什么要使用name: d1.name.clone()这种形式,而不是name: d1.name呢?
  25. // 我想,如冰雪/顽石一般聪明的你,一定知道这背后的原因
  26. // 如果不知道,就在答疑的时候问吧
  27. d1.name.push_str(" 分身一");
  28. d2.name.push_str(" 分身二");
  29. (d1, d2)
  30. }
  31. fn main() {
  32. let monkey_king = Demon {
  33. name: String::from("孙悟空"),
  34. age : 10000,
  35. addr: String::from("花果山")
  36. };
  37. let (mk1, mk2) = split(monkey_king);
  38. println!("{:?}", mk1);
  39. println!("{:?}", mk2);
  40. }

Tuple-Like Struct (TLS)

TLS可以被视为一种具有名字的Tuple。下面的代码给出了TLS声明和使用的示例。

  1. struct Bound(usize, usize);
  2. // 上一行代码声明了一个TLS,它的名称为Bound,内容则是一个二元组(usize, usize)
  3. // 它看起来,就是一个带有名字的Tuple
  4. fn main() {
  5. let b = Bound(1024, 768);
  6. // 上一行创建了Bound的一个实例
  7. // 其中,赋值操作符的右侧,你可以将它视为一种Struct Literal,因为它形成了Bound的一个实例
  8. // 但是,可以看到,Bound(1024, 768)看起来也是一次函数调用
  9. // 是的,它确实是一次函数调用
  10. // 对于一个TLS类型,Rust会自动构造一个同名函数,用于构造该TLS类型的实例
  11. println!("{}, {}", b.0, b.1); //=> 1024, 768
  12. let Bound (b0, b1) = b;
  13. println!("{}, {}", b0, b1); //=> 1024, 768
  14. }

关于TLS,有其他两点信息需要说明:

  1. 一个TLS的实例,可以被partially moved。
  2. 可以为一个TLS的不同分量声明不同的可见性。

这两点信息,与NFS是完全相同的。

Unit-Like Struct (ULS)

ULS可以被视为一种具有名字的0-Tuple。下面的代码给出了ULS声明和使用的示例。

  1. #[derive(Debug)]
  2. struct OneSuch;
  3. // 上一行声明了一个ULS。没错,就是一个名字,其他全都不需要
  4. fn main() {
  5. let o = OneSuch;
  6. // 上一行展示了如何得到一个ULS类型的实例
  7. // 没错,ULS类型的名称就指代了这个ULS类型具有的唯一的那个实例
  8. // 你可能会有疑问:ULS类型的名称,既作为类型名称,又作为实例名称,不会造成歧义吗?
  9. // 其实,你多虑了
  10. // 类型和实例出现在不同的上下文中,编译器可以根据上下文的差异确定名称的含义
  11. // 另外需要注意一点:对于Rust编译器而言,它也不会为ULS类型的变量分配内存空间
  12. println!("{:?}", o); //=> OneSuch
  13. }

ULS有什么特殊的作用吗?谁知道呢,走着瞧呗。

Struct在内存中的排布(Memory Layout)

在这三种形式的Struct中,ULS不涉及内存排布问题,因为它的实例根本就不占用内存空间。对于NFS和TLS,虽然它们在声明和使用时具有显而易见的差异,但是,这两者在内存中的排布方式是完全相同的。
例如,对于一个NFS类型的实例nfs和一个TLS类型的实例tls,对它们各自分量的访问可能表现为nfs.fieldtls.2。这两种具有明显差异的分量访问方式,在经过编译后,都会被转换为分量相对于所在struct实例内存地址的偏移量。也就是说,无论对于NFS还是对于TLS,它们所包含的一组分量,大概都会被以一定的顺序和对齐(allignment)排布在内存中。进而,对于某个分量的访问自然转变为对struct实例内存地址某个偏移量的访问。

  1. fn main() {
  2. let width = 1024;
  3. let height = 768;
  4. let image = ColorImage {
  5. pixels: vec![0; width * height],
  6. size: (width, height)
  7. };
  8. }
  9. struct ColorImage {
  10. size: (usize, usize),
  11. pixels: Vec<u32>
  12. }

对于上面代码中变量image所拥有的这个Struct值,其在内存中的一种可能排布方式如下图所示:
image.png
但是,在缺省情况下,Rust不会对Struct类型的值在内存中的排布做出任何承诺。也就是说,除非明确指定,我们应将Struct在内存中的排布视为一种黑盒。例如,在上面的示例中,我们不应假设分量pixels一定会被排布在size的前面。这样,在未来的版本中,Rust就可能可以根据优化的需要,对排布方式做出改变。
我们可以在声明一个Struct类型时,通过attribute声明指定Struct在内存中的排布方式。例如,属性声明#[repr(C)]表示按照C语言中Struct的排布方式对当前Struct进行表示(Representation)。

在Struct上附着方法

下面,我们通过实现一个具有先进先出行为的队列(Queue),展示如何在Struct上附着方法。

  1. pub struct Queue {
  2. older: Vec<char>,
  3. ynger: Vec<char>
  4. }
  5. // 上面4行代码声明了一个Struct类型,包含两个分量older和ynger,类型均为Vec<char>
  6. // 看到这个类型,你可能会萌发两个问题:
  7. // 问题1:为什么有char类型?回答:这个队列中的元素是char类型的值。
  8. // 问题2:为什么要把一个队列实现为两个向量?回答:慢慢往下看,自然就知道了。
  9. // 以下声明了一个impl代码块 impl Queue { ... },其中声明了若干方法
  10. // 这些方法都是附着在Queue上的方法
  11. impl Queue {
  12. pub fn new() -> Queue {
  13. Queue { older: vec![], ynger: vec![] }
  14. }
  15. // 以上声明了一个new方法,该方法的功能是创建一个Queue的实例
  16. // 为什么说这个方法是附着在Queue上的一个方法呢?
  17. // 因为必须采用Queue::new这种形式才可以访问到这个方法
  18. pub fn is_empty(self: &Queue) -> bool {
  19. self.older.is_empty() && self.ynger.is_empty()
  20. }
  21. // 以上声明了一个is_empty方法,该方法具有一个类型为&Queue的参数
  22. // 该方法的功能是判断传入的这个队列是否是一个空队列(即:队列中不包含任何元素)
  23. pub fn push(self: &mut Queue, c: char) {
  24. self.ynger.push(c);
  25. }
  26. // 以上声明了一个push方法
  27. // 该方法具有两个参数,类型分别为&mut Queue和char
  28. // 该方法的功能是向传入的队列中添加一个元素
  29. // 可以看到,该功能的实现方式就是在ynger分量拥有的向量的末尾添加一个元素
  30. // 与new方法类似,可以采用Queue::push的形式访问到这个方法
  31. // 并按照其要求的参数类型传入实际参数
  32. pub fn pop(self: &mut Queue) -> Option<char> {
  33. if self.older.is_empty() {
  34. if self.ynger.is_empty() {
  35. return None;
  36. }
  37. use std::mem::swap;
  38. swap(&mut self.older, &mut self.ynger);
  39. self.older.reverse();
  40. }
  41. self.older.pop()
  42. }
  43. // 以上声明了一个pop方法;该方法具有一个参数,类型为&mut Queue
  44. // 该方法的功能是从传入的队列中取出一个元素
  45. // 该方法的返回值的类型为Option<char>:
  46. // --当成功地从队列中取出一个元素,则返回一个形状为Some(...)的值
  47. // --如果队列为空,则返回一个形状为None的值
  48. // 这个方法的逻辑稍微复杂一些
  49. // 但是,看懂了这个方法,你就能够理解“为什么要用两个向量而不是一个向量来实现队列”
  50. pub fn split(self: Queue) -> (Vec<char>, Vec<char>) {
  51. (self.older, self.ynger)
  52. }
  53. // 以上展示了一个split方法
  54. // 该方法具有一个参数,类型为Queue
  55. // 这表明,调用这个方法时,传入的队列的所有权会被转移到方法内部
  56. // 这个方法实现的功能很简单:
  57. // --将队列中包含的两个分量older和ynger组织成一个二元组后返回
  58. }
  59. fn main() {
  60. let mut q = Queue::new();
  61. Queue::push(&mut q, 'P'); //== (&mut q).push('P');
  62. // 上一行代码展示了push方法的两种调用方式
  63. // 可以看到,这两种方式具有明显的书写不友好性
  64. // 难道还有更简便的书写方式?有的,稍等一下就介绍
  65. Queue::push(&mut q, 'D'); //== (&mut q).push('D');
  66. assert_eq!(Queue::pop(&mut q), Some('P')); //== (&mut q).pop();
  67. Queue::push(&mut q, 'X'); //== (&mut q).push('X');
  68. let (o, y) = Queue::split(q); //== q.split(q)
  69. assert_eq!(o, vec!['D']);
  70. assert_eq!(y, vec!['X']);
  71. }

上面这段代码具有一些看起来很不友好的表达方式,与Rust如雷贯耳的大名格格不入。现在,让我们给它加一点语法糖,为程序员的生活增加一丝甜蜜的幻觉。

  1. pub struct Queue {
  2. older: Vec<char>,
  3. ynger: Vec<char>
  4. }
  5. impl Queue {
  6. pub fn new() -> Self {
  7. Self { older: vec![], ynger: vec![] }
  8. }
  9. pub fn is_empty(&self) -> bool {
  10. self.older.is_empty() && self.ynger.is_empty()
  11. }
  12. pub fn push(&mut self, c: char) {
  13. self.ynger.push(c);
  14. }
  15. pub fn pop(&mut self) -> Option<char> {
  16. if self.older.is_empty() {
  17. if self.ynger.is_empty() {
  18. return None;
  19. }
  20. use std::mem::swap;
  21. swap(&mut self.older, &mut self.ynger);
  22. self.older.reverse();
  23. }
  24. self.older.pop()
  25. }
  26. pub fn split(self) -> (Vec<char>, Vec<char>) {
  27. (self.older, self.ynger)
  28. }
  29. }
  30. // 在以上impl Queue { ... }代码块中出现的所有Queue,均被替换为Self
  31. // 在一个impl代码块内,Self表示当前被implement的那个type
  32. // 在上面的示例中,那个type就是Queue
  33. // 对于impl Queue { ... }代码块中声明的每一个方法
  34. // 如果它的第一个参数的类型是Queue、mut Queue、&Queue、或&mut Queue
  35. // 那么,这个参数可以分别简写为self、mut self、&self、&mut self
  36. // 这个self参数,大致对应于C++或JavaScript中的this
  37. // 对于impl Queue { ... }代码块中声明的每一个方法
  38. // 如果它的第一个参数是self,那么,在调用这个方法时,可以使用一种简洁形式
  39. // 例如,方法调用Queue::push(&mut q, 'P'),可以被书写为q.push('P')
  40. // 你应该可以看到这种简洁方式所带来的便利:
  41. // --调用一个方法时,不再需要程序员手工确定传入参数的具体形式
  42. // dot操作符.很聪明,它知道该从左边的操作数上取得一个什么形式的值。
  43. fn main() {
  44. let mut q = Queue::new();
  45. q.push('P'); // 怎么样,这种函数调用方式是不是清爽多了
  46. q.push('D');
  47. assert_eq!(q.pop(), Some('P'));
  48. q.push('X');
  49. let (o, y) = q.split();
  50. assert_eq!(o, vec!['D']);
  51. assert_eq!(y, vec!['X']);
  52. }

dot操作符.可能比你想象的还要聪明,它甚至知道如何从BoxRcArc等指针操作数上取到合适的值。请看下面的这个示例:

  1. fn main() {
  2. let mut bq = Box::new(Queue::new());
  3. bq.push('P'); // 1. 从 mut Box<Queue> 获得一个 &mut Queue
  4. bq.push('D'); // 2. 获得方式: &mut *bq
  5. assert_eq!(bq.pop(), Some('P')); // 3. *bq 未发生所有权转移
  6. bq.push('X');
  7. println!("{}", bq.is_empty()); //=> true
  8. // ^ 从 Box<Queue> 获得一个 &Queue
  9. // 获得方式: &*bq
  10. let (o, y) = bq.split(); // 从 Box<Queue> 获得一个 Queue
  11. // *bq 发生了所有权转移
  12. assert_eq!(o, vec!['D']);
  13. assert_eq!(y, vec!['X']);
  14. println!("{}", bq.is_empty()); // Compilation Error
  15. // ^ borrow of moved value: `*bq`
  16. }

在上面的代码示例中:

  • 我们把Queue的一个实例放在一个Box中,并赋值给可变变量bq
  • 然后,我们仍然可以在bq上直接使用dot操作符.访问Queue上附着的各个方法。

下面,我们看看如果把dot操作符.作用到一个Rc类型的值上,会有什么效果。

  1. fn main() {
  2. let mut q = Queue::new();
  3. q.push('P'); q.push('D'); q.pop(); q.push('X');
  4. use std::rc::Rc;
  5. let mut cq = Rc::new(q); // q is moved
  6. // 在以上代码中,我们把Queue的一个实例放在一个Rc中,并赋值给可变变量cq
  7. println!("{}", cq.is_empty()); //=> false
  8. // ^ 从 Rc<Queue> 获得一个 &Queue
  9. // 获得方式: &*cq
  10. //在上一行代码中,我们仍然可以直接在cq上通过dot操作符.访问到Queue上的方法is_empty
  11. cq.push('X'); // Compilation Error: cannot borrow as mutable
  12. // 但是,我们无法在cq上访问push方法
  13. // 因为cq指针指向的值是immutable value,而push方法会改变这个immutable value
  14. // 编译器看到这个矛盾,并报出编译错误。
  15. let (o, y) = cq.split(); // Compilation Error
  16. // ^ cannot move out of an `Rc`
  17. // 类似地,我们无法在cq上访问split方法。原因不难理解:
  18. // --被多个指针指向的一个Rc共享值
  19. // --如果通过一个指针把共享值的所有权转移走了
  20. // --其他指针就只能一起在风中凌乱了
  21. }

仔细思考一下,可以发现,上面两处编译错误,都有些过于严苛了。因为其中的那个Rc值,其引用计数仅为1。因此,通过唯一的引用指针去修改这个值或者转移这个值的所有权,应该也不会发生内存安全问题。只是,目前Rust编译器没有尝试在编译时刻去推断引用计数为1的这种边界情况。

Rc上的两个方法

虽然Rust编译器不会在编译时刻去考虑Rc值引用计数为1的情况,但我们可以在程序运行时刻进行检查,并基于此做出一些高级行为。
第一个方法是get_mut,其基本信息如下图所示:
image.png
这个方法附着在类型Rc<T>上,接收一个类型为&mut Rc<T>的参数,返回一个类型为Option<&mut T>的值。这个方法实现的功能是:当一个Rc值不存在其他引用的情况下,返回一个形状为Some(...)的值,其中包含了对共享值的一个可变引用(使用这个可变引用,自然就可以改变这个共享值了);否则,返回一个None值。该方法的实现代码如下图所示:
image.png
这段实现代码应该不难看明白。其中,方法Rc::is_unique用于判断这个共享值是否只存在唯一一个引用。unsafe{ .. }是一个容纳不安全代码的代码块,初学者就先别惦记它了。
第一个方法是try_unwrap,其基本信息如下图所示:
image.png
这个方法同样也附着在类型Rc<T>上,接收一个类型为Rc<T>的参数,返回一个类型为Result<T, RC<T>>的值。这个方法实现的功能是:当一个Rc值的引用计数为1时,返回一个形状为Ok(...)的值,其中包含了Rc值中包含的那个值;否则,返回一个形状为Err(...)值,其中包含了参数中传入的那个Rc值。需要注意的是,这个函数的参数类型为Rc<T>,前面没有引用操作符&,因此,传入参数的所有权会被转移到函数内部。该方法的实现代码如下图所示:
image.png
即使你看不懂上面这段代码,也不要悲伤,因为,我想,这个内容大概不会出现在试卷上。其实呢,你应该可以看到两个有点类似的方法Rc::is_uniqueRc::strong_count。两者的差别主要在于是否考虑针对共享值的weak pointer。有兴趣的话,自己到相关资料上学习吧。
我们通过一段代码来熟悉一下这两个方法的使用。

  1. fn main() {
  2. use std::rc::Rc;
  3. let mut cq = Rc::new(Queue::new());
  4. let q = Rc::get_mut(&mut cq).unwrap(); // q is a &mut Queue
  5. q.push('P'); q.push('D'); q.pop(); q.push('X');
  6. println!("{}", q.is_empty()); //=> true
  7. let q = Rc::try_unwrap(cq).unwrap(); // q is a Queue
  8. // ^ cq is moved
  9. let (o, y) = q.split(); // q is moved
  10. assert_eq!(o, vec!['D']);
  11. assert_eq!(y, vec!['X']);
  12. }

代码的含义已经很清晰了,无话可说。

为self参数声明类型

上文中讲到,一个类型附着的一个方法,如果具有self参数,其存在一种简便的书写方法,可以不必书写self参数的完整类型。但是,在一些特殊情况下,我们仍然需要为self参数声明完整的类型。请先看如下的代码示例:

  1. use std::rc::Rc;
  2. #[derive(Debug)]
  3. struct Node {
  4. tag: String,
  5. children: Vec<Rc<Node>>
  6. }
  7. // 以上声明了一个类型Node,它包含两个分量。
  8. // 第一个分量的名称为tag,类型为String。其作用大概是给Node实例赋予一个名字。
  9. // 第二个分量的名称为children,类型为Vec<Rc<Node>>。
  10. // 这个分量的作用是用一个向量存放Node实例的子节点
  11. // 这里稍微奇怪的地方在于向量中元素的类型为Rc<Node>
  12. // 这样做的一个好处是:一个Node实例可以被多个变量共享。
  13. // 以下声明了一个impl Node { ... }代码块,其中包含了两个方法
  14. impl Node {
  15. fn new(tag: &str) -> Self {
  16. Self {
  17. tag: tag.to_string(),
  18. children: vec![]
  19. }
  20. }
  21. // 以上方法的作用是创建一个Node实例,其中不包含任何子节点。
  22. fn append_to(self, parent: &mut Node) {
  23. parent.children.push(Rc::new(self));
  24. }
  25. // 以上方法的作用是把一个节点self(类型为Node)添加到一个父节点parent上
  26. // 该方法的实现只包含一条语句,其含义不难理解
  27. }
  28. fn main() {
  29. let mut p = Node::new("parent");
  30. // 创建了一个父节点,并将其赋值给变量p;该变量的类型为 mut Node
  31. let mut c = Rc::new(Node::new("child"));
  32. // 创建了一个子节点,将其放入一个Rc中,并赋值给变量c;该变量的类型为mut Rc<Node>
  33. Rc::try_unwrap(c).unwrap().append_to(&mut p);
  34. // 这是一行惨不忍睹的代码
  35. // 1. 一个Rc中的值被取出来,然后被move到方法 append_to 中
  36. // 2. 在 append_to 方法中,这个值又被move到一个Rc中
  37. // 3. 这里存在明显不必要的操作
  38. println!("{:?}", p);
  39. }

如果上面代码示例中的情况在实际使用中广泛存在,那么,我们可以为apped_to方法的self参数明确声明一个对应的类型,来消除这种不必要的操作。修改后的代码如下:

  1. use std::rc::Rc;
  2. #[derive(Debug)]
  3. struct Node {
  4. tag: String,
  5. children: Vec<Rc<Node>>
  6. }
  7. impl Node {
  8. fn new(tag: &str) -> Self {
  9. Self {
  10. tag: tag.to_string(),
  11. children: vec![]
  12. }
  13. }
  14. // 下面方法的self参数,其声明方式从 self 变为 self: Rc<Self>
  15. fn append_to(self: Rc<Self>, parent: &mut Node) {
  16. parent.children.push(self);
  17. // 因为self已经是一个Rc,可以直接把它push到children中
  18. }
  19. }
  20. fn main() {
  21. let mut p = Node::new("parent");
  22. let mut c = Rc::new(Node::new("child"));
  23. c.append_to(&mut p);
  24. // 1. c的所有权被move到方法 append_to 中
  25. // 2. 在 append_to 方法中,这个值又被move到一个向量中
  26. // 现在看起来,是不是清爽多了;简直就是强迫症的救星!
  27. println!("{:?}", p);
  28. }

在Struct上附着常量

类似于为Struct附着方法,我们也可以在impl代码块内为Struct附着常量。请看如下的代码示例:

  1. #[derive(Debug)]
  2. pub struct Vec2D {
  3. x: f32,
  4. y: f32
  5. }
  6. impl Vec2D {
  7. const NAME: &'static str = "Vec2D";
  8. // 为什么要给NAME的类型指定静态生存期呢?
  9. // 如果你不知道原因,尝试把这个生存期去掉,看看编译器会报出什么错误
  10. const ZERO: Self = Self { x: 0.0, y: 0.0};
  11. const UNIT: Self = Self { x: 1.0, y: 0.0};
  12. fn scaled_by(&self, num: f32) -> Self {
  13. Self { x: self.x * num, y: self.y * num }
  14. }
  15. }
  16. fn main() {
  17. println!("{}", Vec2D::NAME);
  18. println!("{:?}", Vec2D::UNIT.scaled_by(2.0));
  19. }

在上面的文字中,我们介绍了如何通过impl代码块在Struct上附着方法和常量。需要进一步说明的信息有3点:

  1. 对Rust语言中的任何类型(不仅仅局限于Struct类型)而言,都可以通过impl代码块为其附着方法和常量
  2. 一个类型,可以具有多个impl代码块,但是它们必须全部出现在类型所在的crate中
  3. Rust不允许在一个类型所在的crate外声明该类型的impl代码块

    Generic Struct

    在上面的代码示例中,我们声明了Queue类型,它可以对一组char类型的值进行排队。这里存在一个明显的问题:如果需要对其他类型的值进行排队,我需要把Queue相关代码复制后把其中的char全部替换为另一种类型。与C++或其他语言类似,Rust提供了Generic机制来解决这个问题。请看下面的代码示例: ```rust

    [derive(Debug)]

    pub struct Queue { older: Vec, ynger: Vec } // 上面的Struct类型是一种Generic Struct,因为它带有类型参数T // 这个Struct类型,应做如下理解: // —对于任何类型T,Queue是一个Struct类型,其中包含两个分量,类型均为Vec

// 下面的impl Queue{ … } 应做如下理解: // — 对于任何类型T,下面的代码块中定义了若干附着在类型Queue的方法或常量 impl Queue { pub fn new() -> Self { Self { older: vec![], ynger: vec![] } }

  1. pub fn is_empty(&self) -> bool {
  2. self.older.is_empty() && self.ynger.is_empty()
  3. }
  4. pub fn push(&mut self, t: T) {
  5. self.ynger.push(t);
  6. }
  7. pub fn pop(&mut self) -> Option<T> {
  8. if self.older.is_empty() {
  9. if self.ynger.is_empty() {
  10. return None;
  11. }
  12. use std::mem::swap;
  13. swap(&mut self.older, &mut self.ynger);
  14. self.older.reverse();
  15. }
  16. self.older.pop()
  17. }
  18. pub fn split(self) -> (Vec<T>, Vec<T>) {
  19. (self.older, self.ynger)
  20. }

}

// 下面的 impl Queue{ … } 代码块,应做如下理解: // —下面的代码块中定义了若干附着在类型Queue的方法或常量 // 看到有趣的地方了吧! // 我们既可以为Queue附着方法或常量,也可以为Queue附着一些更加特定的方法或常量 impl Queue { pub fn sum(&self) -> f64 { let mut rst = 0.0; for v in &self.older[..] { rst += v; } for v in &self.ynger[..] { rst += v; } rst } }

fn main() { let mut q = Queue::::new();

  1. q.push(2.1); q.push(3.1); q.pop(); q.push(1.1);
  2. println!("{}", q.sum()); //=> 4.2

}

  1. <a name="xul8a"></a>
  2. ## 带有生存期参数的Struct
  3. 当一个Struct类型的某一个或多个分量的类型是引用类型时,或者分量的类型具有生命期参数时,我们需要为这个Struct类型声明生存期参数。请看下面的示例:
  4. ```rust
  5. struct Extrema<'elt> {
  6. min: &'elt i32, max: &'elt i32
  7. }
  8. // 以上声明的Struct类型具有两个分量,类型均为&i32
  9. // 我们通过声明生存期参数,指定这两个分量具有相同的生存期
  10. // 这下面这个函数的签名中,我们声明了它具有一个生存期参数,且声明其参数与返回值具有相同的生存期
  11. // 按照我们在前文中的叙述,这种情况下即使不声明生存期参数,编译器也会自动推断出相同的生存期效果
  12. fn find_extrema<'s>(slice: &'s [i32]) -> Extrema<'s> {
  13. let mut min = &slice[0];
  14. let mut max = min;
  15. for v in &slice[1..] {
  16. if v < min { min = v; }
  17. else if v > max { max = v; }
  18. }
  19. Extrema { min, max }
  20. }
  21. fn main() {
  22. let a = [0, -3, 8, -15, 42];
  23. let e = find_extrema(&a);
  24. println!("{}", e.min); //=> -15
  25. println!("{}", e.max); //=> 42
  26. }

为Struct附着常用Traits

可以看到,声明一个Struct是非常方便的。例如,使用下面的代码片段,我们可以声明一个Struct用于表示二维空间中的点:

  1. struct Point {
  2. x: f64
  3. y: f64
  4. }

定义的方式很简洁直观。但是,使用起来却没有那么方便。例如:

  • Point类型not copyable,虽然它的每一个分量都是copyable。这导致的一个后果是:当把Pointx类型的变量赋值给另一个变量或传入一个函数时,会发生所有权的转移;而有时,这并不是我们所期望的。
  • Point类型not cloneable。如果要克隆一个Point类型的值,必须自己编写克隆函数;很麻烦。
  • Point类型not printable:无法通过println!("{:?}", ...)语句打印一个Point类型的值。这给程序的调试带来了显然的不便捷性。同样,你可以通过手工实现特定的方法来实现Point类型printable;很麻烦。
  • 无法通过==!=操作符判断两个Point类型的值是否相等。

以上列出的每一种期望特性,在Rust中被称为一个trait。Tarit大概对应于Java语言中的interface,但绝对不是完全等价于interface;这一点,我们在后文中会详细介绍。
对于每一种自定义类型,如果都需要程序员手工实现这些常用的trait,实在是不方便。为此,Rust提供了相应的attribute声明,告诉编译器针对自定义的类型自动生成相应的trait。具体声明方式如下:

  1. #[derive(Copy, Clone, Debug, PartialEq)]
  2. struct Point {
  3. x: f64
  4. y: f64
  5. }

其中:CopyCloneDebugPartialEq是Rust语言中定义的4个trait,分别对应于上面的四种特性。其中,对于Copytrait的声明,如果当前Type无法被实现为copy type,则编译器会报错。

Interior Mutability

:::info 对于这部分的内容,我目前的理解还不够透彻。如果有错误或不合适的地方,请指出。 ::: Rust编译器在编译时刻确保如下性质成立: :::warning 共享引用指向的值不可被改变
(Shared references are immutable) ::: 看到这样的性质,我们不禁要问:

  1. “共享”(Sharing)与“改变”(Mutating),两者在本质上互斥吗?这种互斥,闻所未闻。
  2. 既然如此,Rust为何要施加这样的限制呢?据说,同时拥有“共享”与“改变”,经常导致内存安全问题。
  3. 确实是“经常”,而非总是?是的,经常而非总是。
  4. 那么,会伤及非经常吗?emmm…

为了让“共享”和“改变”和谐共存,Rust提供了两种Struct类型:Cell<T>RefCell<T>。这两种类型是一种shareable mutable containers,即:一种容器,可以让改变其中存在的被共享的值。

Cell<T>

在Rust文档中,Cell类型的基本信息如下:
image.png
可以看到:

  • 一个Cell实例中存放的值,既可以是定长(Sized)的,也可以是不定长的。
  • 一个Cell实例表示了内存中一块可以被改变的区域

下图给出了Cell<T>类型的使用示例。
image.png
在上面的示例中:

  • 类型SomeStruct的具有两个分量:分量regular_field的类型为u8;分量special_field的类型为Cell<u8>
  • 我们创建了SomeStruct的一个实例,并将其赋值给不可变变量my_struct
  • 如不可变变量的性质可知,我们无法改变my_struct.special_field的值;编译器会确保这一点
  • 但是,我们可以使用Cell<T>上附着的set方法去修改其中存放的那个u8类型的值

从上面这个示例,我们可以大概感受到Interior Mutability(内部可变性)这个概念的含义:

  • 从外部来看,my_struct.special_field的值不可被改变
    • 也即:如果程序中出现了my_struct.special_field = ...;这样的赋值语句,即使类型检查能够通过,编译器也一定会报出编译错误
  • 从内部来看,my_struct.special_field是一个Cell<T>类型的值;我们可以通过Cell<T>类型上附着的方法去修改cell中存放的那个值。

下面,我们介绍Cell上附着的若干典型方法。

impl<T> Cell<T> { ... }中定义的方法

这个Generic代码块的含义是:对于任意定长类型TCell<T>上附着了一些方法。
image.png
方法new的功能是:创建Cell<T>类型的一个实例。其中存放的那个值通过方法的参数传入。显然可知:如果T不是一个Copy类型的值,则参数的所有权会被转移到方法内部。
image.png
方法set的功能是:通过Cell<T>实例的共享引用,改变其中存放的那个值。
image.png
方法swap的功能是:通过Cell<T>的两个实例的共享引用,交互各自拥有的值。
image.png
方法replace的功能是:通过Cell<T>的实例的共享引用,用一个值替换其中存放的值,并返回那个被替换的旧值。
image.png
函数into_inner的功能是:把一个Cell实例的所有权拿过来,然后把这个实例拆了,取出并返回其中存放的那个值。

impl<T: Copy> Cell<T> { ... }中定义的方法

这个Generic代码块的含义是:对于任意定Copy类型TCell<T>上附着了一些方法。
image.png
方法get的功能是:给定Cell<T: Copy>实例的共享引用,返回其中存放的那个值的一个拷贝。

impl<T: ?Sized> Cell<T> { ... }中定义的方法

这个Generic代码块的含义是:对于任意类型T(定长或者非定常),Cell<T>上附着了一些方法。
image.png
方法get_mut的功能是:给定Cell<T: ?Sized>实例的一个可变引用,返回对其中存放的那个值的可变引用。
image.png
方法from_mut的功能是:给定一个类型为&mut T的值,将这个值封装在一个cell中,并返回这个cell的共享引用。

其它代码块中定义的方法

Cell<T>还通过如下代码块附着了一些方法:

  • impl<T: Default> Cell<T> { … }
  • impl<T> Cell<[T]> { … }
  • impl<T, const N: usize> Cell<[T; N]> { … }

同时,Cell<T>还实现了一些trait,例如:CloneDebugDefault等。
如果有兴趣,可以去Rust标准库文档中查阅这些方法。


关于Cell<T>,可以观察到如下事实:

  1. 对于任意定长类型T的任意实例,可以通过newset方法将该值放入一个cell中
  2. 如果cell中存放了一个定长类型的值,无论cell是否可变,都可通过swapreplace方法改变其中存放的值
  3. 如果cell中存放了一个Copy类型的值,可通过get方法读取其中存放的值;但get方法不适用非Copy类型值
  4. 若要获得cell中值的可变引用,必须获得cell的可变引用
  5. 不存在一个同时满足如下两个条件的cell:A. cell中存放的值非定长; B. cell可变

    RefCell<T>

    Rust语法中存在对“一个值可以同时存在引用”的两条限制(在英文中被称为borrow rules):

  6. 对于任意一个值,如下两个条件不能同时成立:

    1. 存在对这个值的一个或多个共享引用(&T
    2. 存在对这个值的一个可变引用(&mut T
  7. 对于任意一个值,不能同时存在对这个值的两个或多个可变引用

在一般情况下,Rust会在编译时刻会确保上述borrow rules得到满足;如果不满足,则报出编译错误。
但是,我们可以通过RefCell,把对borrow rules的检查推迟到运行时进行。
image.png

**impl<T> RefCell<T> { ... }**

这个Generic代码块的含义是:对于任意定长类型TRefCell<T>上附着了一些方法。
image.png
方法new的功能是:创建RefCell<T>类型的一个实例。其中存放的那个值通过方法的参数传入。
image.png
方法into_inner的功能是:获得RefCell类型的一个实例的所有权,把它拆了,返回其中存放的那个值。
image.png
方法replace的功能是:用一个值,替换RefCell<T>类型的一个实例中存放的那个值。
这个方法有可能产生panic:如果RefCell<T>类型的这个实例存放的那个值已经被另一个变量所引用,则该方法会产生panic。这就是前面所说的:通过RefCell,可以把对borrow rules的检查推迟到运行时进行。因为有其它变量引用这个值,所以这个值不能被改变。
image.png
方法swap的功能是:通过RefCell<T>类型的两个实例的共享引用,交互各自拥有的值。
这个方法也有可能发生panic。原因如前所述:该方法调用不满足borrow rules。

**impl<T: ?Sized> RefCell<T> { ... }**

这个Generic代码块的含义是:对于任意类型T(定长或者非定常),RefCell<T>上附着了一些方法。
image.png
方法borrow的功能是:获得RefCell<T: ?Sized>类型的一个实例中存放的那个值的共享引用。如果这个值已经存在了可变引用,则该方法调用会产生panic。
这个方法返回的值是一种专门针对RefCell<T>设计的共享引用类型;当该引用类型的值离开当前作用域后,对被引用值的引用就消失了。
下面给出了该方法的两个示例程序:
image.pngimage.png
下面给出borrow方法的非panic版本:
image.png
这个方法返回一个Result类型的值:当成功获得RefCell<T: ?Sized>中值的共享引用时,返回一个Ok(...)值;否则,返回一个Err(...)值。
下面给出了该方法的一个使用示例:
image.png
下面介绍borrowtry_borrow两个方法对应的可变引用版本:borrow_muttry_borrow_mut
image.png
方法borrow_mut的功能是:获得RefCell<T: ?Sized>类型的一个实例中存放的那个值的可变引用。如果这个值已经存在了可变引用或共享引用,则该方法调用会产生panic。
这个方法返回的值是一种专门针对RefCell<T>设计的可变引用类型;当该引用类型的值离开当前作用域后,对被引用值的引用就消失了。
下面给出了该方法的两个示例程序:
image.pngimage.png
下面给出borrow_mut方法的非panic版本:
image.png
该方法的一个使用示例如下图所示:
image.png


我们用一张表总结一下刚才介绍的这组方法:

Cell RefCell
Sized new()set()into_inner() new()into_inner()
?Sized swap()replace() _swap_()_replace_()
Copy get()
?Sized _brrow_()_brrow_mut_()
try_brrow()try_brrow_mut()

上面表格中,斜体方法名表示该方法可能会产生panic。

Rust官方文档中的三个示例

在Rust语言标准库文档中,针对Interior Mutability,给出了三个示例。

Introducing mutability inside of something immutable

第一个示例主要关于如何在一个外表看起来不可变的变量内部引入可变性。请看如下代码示例。
image.png
在这个示例中:

  • 声明了一个不可变变量shared_map,其类型为Rc<RefCell<HashMap>>
  • 然后,在一个代码块内部,通过borrow_mut方法获得RefCell中存放的那个HashMap值的可变引用,并利用这个可变引用对HashMap值进行了修改;这个代码块结束后,对HashMap值的可变引用生存期结束。
  • 最后,通过borrow方法获得RefCell中存放的那个HashMap值的共享引用,并利用这个共享引用调用了HashMap值上的只读方法values

    Implementation details of logically-immutable methods

    第二个示例主要关于如何实现一个逻辑上不可变的方法(即:该方法的执行不会在逻辑上改变所附着的那个值)。请看如下代码示例。
    image.png
    在这个示例中:

  • Graph类型的一个分量是span_tree_cache,其类型为RefCell<Option<Vec<(i32, i32)>>>。这个分量的主要作用是作为计算过程中的一个缓存区。

  • 具体而言,当在一个Graph实例上调用minumum_spanning_tree方法时,首先查看span_tree_cache中是否存在一个Some值;如果存在,则直接将其克隆后返回;否则,调用一个计算量很大的函数计算出span_tree,放入minumum_spanning_tree,然后对其中的值克隆后返回

    Mutating implementations of Clone

    第三个示例主要关于Rc上的clone方法。
    image.png
    当我们在一个Rc值上调用clone方法时,实际上对Rc指向的那个值进行了改变。这种效果就是利用Interior Mutability实现的。

:::warning 本章内容到此结束 :::