Union std::mem::ManuallyDrop1.20.0 [] [src]

pub union ManuallyDrop<T> {
    // some fields omitted

A wrapper to inhibit compiler from automatically calling T’s destructor.

This wrapper is 0-cost.


This wrapper helps with explicitly documenting the drop order dependencies between fields of the type:

use std::mem::ManuallyDrop;
struct Peach;
struct Banana;
struct Melon;
struct FruitBox {
    // Immediately clear there’s something non-trivial going on with these fields.
    peach: ManuallyDrop<Peach>,
    melon: Melon, // Field that’s independent of the other two.
    banana: ManuallyDrop<Banana>,

impl Drop for FruitBox {
    fn drop(&mut self) {
        unsafe {
            // Explicit ordering in which field destructors are run specified in the intuitive
            // location – the destructor of the structure containing the fields.
            // Moreover, one can now reorder fields within the struct however much they want.
            ManuallyDrop::drop(&mut self.peach);
            ManuallyDrop::drop(&mut self.banana);
        // After destructor for `FruitBox` runs (this function), the destructor for Melon gets
        // invoked in the usual manner, as it is not wrapped in `ManuallyDrop`.


impl<T> ManuallyDrop<T>

Wrap a value to be manually dropped.


use std::mem::ManuallyDrop;

Extract the value from the ManuallyDrop container.


use std::mem::ManuallyDrop;
let x = ManuallyDrop::new(Box::new(()));
let _: Box<()> = ManuallyDrop::into_inner(x);Run

Manually drops the contained value.


This function runs the destructor of the contained value and thus the wrapped value now represents uninitialized data. It is up to the user of this method to ensure the uninitialized data is not actually used.

Trait Implementations

impl<T> Debug for ManuallyDrop<T> where
    T: Debug

Formats the value using the given formatter.

impl<T> Deref for ManuallyDrop<T>

The resulting type after dereferencing

The method called to dereference a value

impl<T> DerefMut for ManuallyDrop<T>

The method called to mutably dereference a value