Rust 编程语言有提供泛型和生命周期机制,在定义枚举或是结构体的时候,可以利用泛型来指定结构体的字段类型,使我们在程序撰写阶段不必明确地限制住这个结构体到底能保存哪些类型的数据。如果要进一步的限制泛型类型参数所代表的类型范围,可以替泛型类型参数加上特性的限制,使其所对应的类型必须要有实作指定的特性。但是,当特性有使用到泛型生命周期参数的话,就可能会遇到一些问题了。
例如现在有个特性 A,它有一个泛型生命周期参数 'a,可以将符合这个生命周期参数的字符串切片回传出来。
trait A<'a> {
fn as_str(&'a self) -> &'a str;
}
然后我们希望有个结构体 B,可以保存实作了这个特性 A 的类型实体,因此我们会很直觉地如以下这样定义结构体 B:
struct B<'a, T: A<'a>> {
s: T
}
但是以上程序在编译阶段时会出现问题,因为编译器并不知道泛型生命周期参数 'a 到底是什么,因为它在结构体 B 的数据字段中并没有被使用到。这部份很奇怪,数据字段怎么会没有使用到泛型生命周期参数 'a 呢?泛型类型参数 T 不就表明了其所代表的类型必须要实作 A<'a> 特性吗?
在一开始笔者以为这是 Rust 编程语言的 Bug,所以都先将结构体改用以下的方式定义来暂时解决这个问题:
struct B<'a, T: A<'a>> {
s: T,
_not_used: &'a str,
}
如果是枚举的话就会长这样:
enum C<'a, T: A<'a>> {
V1(T),
_NotUsed(&'a str),
}
这样的作法虽然可以解决编译的问题,却会导致枚举或是结构体的类型大小变大,因为它必须要多保存一个 &'a str 参考,并且也不是说在所有情况下都适用这样的解决方案。
随着后来愈来愈了解 Rust 编程语言后,就发现标准函数库的 marker 模块有提供一个 PhantomData 结构体,就是专门用来解决这个问题的。
PhantomData 结构体有一个泛型类型参数 T,这个 T 具体是什么类型并没有任何限制,且 PhantomData 结构体本身是不占空间的(zero-sized)。将以上的结构体和枚举改用 PhantomData 结构体来定义的话,就会变成以下这样:
use std::marker::PhantomData;
struct B<'a, T: A<'a>> {
s: T,
_not_used: PhantomData<&'a str>,
}
enum C<'a, T: A<'a>> {
V1(T),
_NotUsed(PhantomData<&'a str>),
}
如果要更好看一点,可以写成这样:
use std::marker::PhantomData;
struct B<'a, T: A<'a>> {
s: T,
_not_used: PhantomData<&'a T>,
}
enum C<'a, T: A<'a>> {
V1(T),
_NotUsed(PhantomData<&'a T>),
}
我们不用担心具体要给 PhantomData 的数据字段什么值,通通传入 PhantomData 就好了。什么意思呢?直接看代码吧!
impl<'a, T: A<'a>> B<'a, T> {
fn new(s: T) -> Self {
B {
s,
_not_used: PhantomData,
}
}
}
以上程序中,我们在创建结构体 B 的实体时,在 PhantomData 的数据字段中,直接指派了 PhantomData 给它。
如果是枚举的话,我们甚至可以不必管 PhantomData 的数据字段。如下:
impl<'a, T: A<'a>> C<'a, T> {
fn v1(s: T) -> Self {
C::V1(s)
}
}
所以说,Rust 编程语言中所谓的幽灵数据(PhantomData)其实就是作为枚举或结构体中的数据字段,纯粹为了要给编译器看所设计的数据类型啦!幽灵数据除了能处理上述的有用到泛型生命周期参数的特性外,也可以处理有用到泛型类型参数的特性。
来复杂化一下上述的例子,将特性 A 的定义改成以下这样:
trait A<'a, K> {
fn as_type(&'a self) -> &'a K;
}
结构体 B 的定义改成以下这样:
struct B<'a, K, T: A<'a, K>> {
s: T,
_not_used: PhantomData<&'a T>,
}
编译时会发现结构体 B 编译失败,原因在于它的数据字段中并没有用到泛型类型参数 K,此时的解法很简单,我们已经会了,只要想办法将我们没用到的泛型参数都塞给 PhantomData 的数据字段来用就好了。于是乎,修改后的结构体 B 的代码如下:
struct B<'a, K, T: A<'a, K>> {
s: T,
_not_used: PhantomData<&'a K>,
}
