Struct std::marker::PhantomData

pub struct PhantomData<T>
where
         T: ?Sized;

零大小的类型用来标记那些行为像它们拥有一个 T 的东西。

向您的类型添加 PhantomData<T> 字段将告诉编译器，您的类型的行为就像它存储了 T 类型的值一样，即使实际上并非如此。 在计算某些安全属性时会使用此信息。

有关如何使用 PhantomData<T> 的更深入的说明，请参见 the Nomicon。

一个可怕的笔记 👻👻👻

尽管它们都有可怕的名称，但 PhantomData 和 phantom 类型是相关的，但并不完全相同。phantom 类型参数只是从未使用过的类型参数。 在 Rust 中，这通常会导致编译器抱怨，而解决方案是通过 PhantomData 添加 “dummy” 用途。

Examples

未使用的生命周期参数

PhantomData 的最常见用例也许是具有未使用的生命周期参数的结构体，通常将其用作某些不安全代码的一部分。 例如，这是一个结构体 Slice，它具有两个 *const T 类型的指针，大概指向某个地方的数组：

struct Slice<'a, T> {
    start: *const T,
    end: *const T,
}

目的是底层数据仅在生命周期 'a 内有效，因此 Slice 不应超过 'a。 但是，此意图未在代码中表达，因为没有使用生命周期 'a，因此尚不清楚它适用于什么数据。 我们可以通过告诉编译器如果 Slice 结构体包含引用 &'a T 来执行 *as 来纠正此问题：

use std::marker::PhantomData;

struct Slice<'a, T> {
    start: *const T,
    end: *const T,
    phantom: PhantomData<&'a T>,
}

这也反过来推断生命周期绑定 T: 'a，表明 T 中的任何引用在生命周期 'a 内有效。

初始化 Slice 时，只需为字段 phantom 提供值 PhantomData：

fn borrow_vec<T>(vec: &Vec<T>) -> Slice<'_, T> {
    let ptr = vec.as_ptr();
    Slice {
        start: ptr,
        end: unsafe { ptr.add(vec.len()) },
        phantom: PhantomData,
    }
}

未使用的类型参数

有时可能会发生未使用的类型参数，这些参数指示 “tied” 将结构体数据类型化的数据，即使该数据实际上不是在结构体本身中找到的也是如此。

这是 FFI 出现此情况的示例。 外部接口使用 *mut () 类型的句柄来引用不同类型的 Rust 值。 我们使用包裹句柄的结构体 ExternalResource 上的 phantom 类型参数来跟踪 Rust 类型。

use std::marker::PhantomData;
use std::mem;

struct ExternalResource<R> {
   resource_handle: *mut (),
   resource_type: PhantomData<R>,
}

impl<R: ResType> ExternalResource<R> {
    fn new() -> Self {
        let size_of_res = mem::size_of::<R>();
        Self {
            resource_handle: foreign_lib::new(size_of_res),
            resource_type: PhantomData,
        }
    }

    fn do_stuff(&self, param: ParamType) {
        let foreign_params = convert_params(param);
        foreign_lib::do_stuff(self.resource_handle, foreign_params);
    }
}

所有权和 drop 检测

PhantomData 与丢弃检查的确切交互可能会在 future中发生变化。

目前，添加 PhantomData<T> 类型的字段表示在极少数情况下您的类型拥有T 类型的数据。 这反过来又会影响 Rust 编译器的 drop check 分析。 有关确切规则，请参见 drop check 文档。

Layout

对于所有 T，保证以下内容:

• size_of::<PhantomData<T>>() == 0
• align_of::<PhantomData<T>>() == 1

Trait Implementations

impl<T> Clone for PhantomData<T>where T: ?Sized,

fn clone(&self) -> PhantomData<T>

返回值的副本。

fn clone_from(&mut self, source: &Self)

从 source 执行复制分配。

impl<T> Debug for PhantomData<T>where T: ?Sized,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

使用给定的格式化程序格式化该值。

impl<T> Default for PhantomData<T>where T: ?Sized,

fn default() -> PhantomData<T>

返回类型的 “默认值”。

impl<T> Hash for PhantomData<T>where T: ?Sized,

fn hash<H>(&self, _: &mut H)where H: Hasher,

将该值输入给定的 Hasher。

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

将这种类型的切片送入给定的 Hasher 中。

impl<T> Ord for PhantomData<T>where T: ?Sized,

fn cmp(&self, _other: &PhantomData<T>) -> Ordering

此方法返回 self 和 other 之间的 Ordering。

fn max(self, other: Self) -> Selfwhere Self: Sized,

比较并返回两个值中的最大值。

fn min(self, other: Self) -> Selfwhere Self: Sized,

比较并返回两个值中的最小值。

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

将值限制在某个时间间隔内。

impl<T> PartialEq<PhantomData<T>> for PhantomData<T>where T: ?Sized,

fn eq(&self, _other: &PhantomData<T>) -> bool

此方法测试 self 和 other 值是否相等，并由 == 使用。

fn ne(&self, other: &Rhs) -> bool

此方法测试 !=。 默认实现几乎总是足够的，并且不应在没有充分理由的情况下被覆盖。

impl<T> PartialOrd<PhantomData<T>> for PhantomData<T>where T: ?Sized,

fn partial_cmp(&self, _other: &PhantomData<T>) -> Option<Ordering>

如果存在，则此方法返回 self 和 other 值之间的顺序。

fn lt(&self, other: &Rhs) -> bool

此方法测试的内容少于 (对于 self 和 other)，并且由 < 操作员使用。

fn le(&self, other: &Rhs) -> bool

此方法测试小于或等于 (对于 self 和 other)，并且由 <= 运算符使用。

fn gt(&self, other: &Rhs) -> bool

此方法测试大于 (对于 self 和 other)，并且由 > 操作员使用。

fn ge(&self, other: &Rhs) -> bool

此方法测试是否大于或等于 (对于 self 和 other)，并且由 >= 运算符使用。

impl<T> Copy for PhantomData<T>where T: ?Sized,

impl<T> Eq for PhantomData<T>where T: ?Sized,

impl<T> StructuralEq for PhantomData<T>where T: ?Sized,

impl<T> StructuralPartialEq for PhantomData<T>where T: ?Sized,