Struct std::mem::ManuallyDrop

#[repr(transparent)]
pub struct ManuallyDrop<T> where
    T: ?Sized,  { /* fields omitted */ }

包装器，用于禁止编译器自动调用 T 的析构函数。 该包装器的成本为 0。

ManuallyDrop<T> 与 T 进行相同的布局优化。 因此，它在编译器对其内容进行假设的前提下具有 no 效果。 例如，用 mem::zeroed 初始化 ManuallyDrop<&mut T> 是未定义的行为。 如果需要处理未初始化的数据，请改用 MaybeUninit<T>。

请注意，访问 ManuallyDrop<T> 内部的值是安全的。 这意味着其内容已被丢弃的 ManuallyDrop<T> 一定不能通过公共安全 API 公开。 相应地，ManuallyDrop::drop 是不安全的。

ManuallyDrop 和 drop 指令。

Rust 具有定义明确的 drop order 值。 为确保按特定顺序丢弃字段或局部变量，请对声明重新排序，以使隐式丢弃顺序正确。

可以使用 ManuallyDrop 来控制丢弃顺序，但这需要不安全的代码，并且在展开状态下很难正确执行。

例如，如果您想要确保一个特定的字段在其他字段之后被丢弃，将它作为结构的最后一个字段:

struct Context;

struct Widget {
    children: Vec<Widget>,
    // `context` 将在 `children` 之后被丢弃。
    // Rust 保证按声明顺序丢弃字段。
    context: Context,
}

Implementations

impl<T> ManuallyDrop<T>

#[must_use = "if you don't need the wrapper, you can use `mem::forget` instead"]

pub const fn new(value: T) -> ManuallyDrop<T>

包装一个要手动丢弃的值。

Examples

use std::mem::ManuallyDrop;
let mut x = ManuallyDrop::new(String::from("Hello World!"));
x.truncate(5); // 您仍然可以安全地操作值
assert_eq!(*x, "Hello");
// 但是 `Drop` 不会在这里运行

pub const fn into_inner(slot: ManuallyDrop<T>) -> T

从 ManuallyDrop 容器中提取值。

这样可以再次丢弃该值。

Examples

use std::mem::ManuallyDrop;
let x = ManuallyDrop::new(Box::new(()));
let _: Box<()> = ManuallyDrop::into_inner(x); // 这将使 `Box` 丢弃。

#[must_use = "if you don't need the value, you can use `ManuallyDrop::drop` instead"]

pub unsafe fn take(slot: &mut ManuallyDrop<T>) -> T

从 ManuallyDrop<T> 容器中取出值。

此方法主要用于在 drop 中移出值。 您可以使用此方法获取值并根据需要使用它，而不是使用 ManuallyDrop::drop 手动删除该值。

只要有可能，最好改用 into_inner，这样可以防止重复 ManuallyDrop<T> 的内容。

Safety

该函数从语义上移出所包含的值，而不会阻止进一步使用，从而使该容器的状态保持不变。 您有责任确保不再使用此 ManuallyDrop。

impl<T> ManuallyDrop<T> where
    T: ?Sized, 

pub unsafe fn drop(slot: &mut ManuallyDrop<T>)

手动丢弃包含的值。这完全等同于使用指向所包含值的指针来调用 ptr::drop_in_place。 这样，除非所包含的值是包装的结构体，否则析构函数将在不移动值的情况下就地调用，因此可用于安全地丢弃 pinned 数据。

如果您拥有该值的所有权，则可以改用 ManuallyDrop::into_inner。

Safety

此函数运行包含值的析构函数。 除了析构函数本身所做的更改之外，内存保持不变，因此就编译器而言，仍然保留一种对于 T 类型有效的位模式。

但是，此 “zombie” 值不应暴露给安全代码，并且不应多次调用此函数。 在丢弃值或多次丢弃值后使用该值可能会导致未定义行为 (取决于 drop 的作用)。 类型系统通常会阻止这种情况，但是 ManuallyDrop 的用户必须坚持这些保证，而无需编译器的帮助。

Trait Implementations

impl<T> Clone for ManuallyDrop<T> where
    T: Clone + ?Sized, 

pub fn clone(&self) -> ManuallyDrop<T>

返回值的副本。

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

从 source 执行复制分配。

impl<T> Debug for ManuallyDrop<T> where
    T: Debug + ?Sized, 

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

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

impl<T> Default for ManuallyDrop<T> where
    T: Default + ?Sized, 

pub fn default() -> ManuallyDrop<T>

返回类型的 “default value”。

impl<T> Deref for ManuallyDrop<T> where
    T: ?Sized, 

type Target = T

解引用后的结果类型。

pub fn deref(&self) -> &T

解引用值。

impl<T> DerefMut for ManuallyDrop<T> where
    T: ?Sized, 

pub fn deref_mut(&mut self) -> &mut T

可变地解引用该值。

impl<T> Hash for ManuallyDrop<T> where
    T: Hash + ?Sized, 

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

将该值输入给定的 Hasher。

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

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

impl<T> Ord for ManuallyDrop<T> where
    T: Ord + ?Sized, 

pub fn cmp(&self, other: &ManuallyDrop<T>) -> Ordering

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

fn clamp(self, min: Self, max: Self) -> Self

将值限制为一定的时间间隔。

impl<T> PartialEq<ManuallyDrop<T>> for ManuallyDrop<T> where
    T: PartialEq<T> + ?Sized, 

pub fn eq(&self, other: &ManuallyDrop<T>) -> bool

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

pub fn ne(&self, other: &ManuallyDrop<T>) -> bool

此方法测试 !=。

impl<T> PartialOrd<ManuallyDrop<T>> for ManuallyDrop<T> where
    T: PartialOrd<T> + ?Sized, 

pub fn partial_cmp(&self, other: &ManuallyDrop<T>) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

impl<T> Copy for ManuallyDrop<T> where
    T: Copy + ?Sized, 

impl<T> Eq for ManuallyDrop<T> where
    T: Eq + ?Sized, 

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

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