Struct std::mem::ManuallyDrop

1.20.0 · source ·

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

Expand description

A wrapper to inhibit compiler from automatically calling T’s destructor. This wrapper is 0-cost.

ManuallyDrop<T> is guaranteed to have the same layout as T, and is subject to the same layout optimizations as T. As a consequence, it has no effect on the assumptions that the compiler makes about its contents. For example, initializing a ManuallyDrop<&mut T> with mem::zeroed is undefined behavior. If you need to handle uninitialized data, use MaybeUninit<T> instead.

Note that accessing the value inside a ManuallyDrop<T> is safe. This means that a ManuallyDrop<T> whose content has been dropped must not be exposed through a public safe API. Correspondingly, ManuallyDrop::drop is unsafe.

ManuallyDrop and drop order.

Rust has a well-defined drop order of values. To make sure that fields or locals are dropped in a specific order, reorder the declarations such that the implicit drop order is the correct one.

It is possible to use ManuallyDrop to control the drop order, but this requires unsafe code and is hard to do correctly in the presence of unwinding.

For example, if you want to make sure that a specific field is dropped after the others, make it the last field of a struct:

struct Context;
struct Widget {
 children: Vec<Widget>,
 // `context` will be dropped after `children`.
 // Rust guarantees that fields are dropped in the order of declaration.
 context: Context,
}

Run

Implementations

source

impl<T> ManuallyDrop<T>

const: 1.32.0 · source

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

Wrap a value to be manually dropped.

Examples

use std::mem::ManuallyDrop;
let mut x = ManuallyDrop::new(String::from("Hello World!"));
x.truncate(5); // You can still safely operate on the value
assert_eq!(*x, "Hello");
// But `Drop` will not be run here

Run

const: 1.32.0 · source

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

Extracts the value from the ManuallyDrop container.

This allows the value to be dropped again.

Examples

use std::mem::ManuallyDrop;
let x = ManuallyDrop::new(Box::new(()));
let _: Box<()> = ManuallyDrop::into_inner(x); // This drops the `Box`.

Run

1.42.0 · source

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

Takes the value from the ManuallyDrop<T> container out.

This method is primarily intended for moving out values in drop. Instead of using ManuallyDrop::drop to manually drop the value, you can use this method to take the value and use it however desired.

Whenever possible, it is preferable to use into_inner instead, which prevents duplicating the content of the ManuallyDrop<T>.

Safety

This function semantically moves out the contained value without preventing further usage, leaving the state of this container unchanged. It is your responsibility to ensure that this ManuallyDrop is not used again.

source

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

source

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

Manually drops the contained value. This is exactly equivalent to calling ptr::drop_in_place with a pointer to the contained value. As such, unless the contained value is a packed struct, the destructor will be called in-place without moving the value, and thus can be used to safely drop pinned data.

If you have ownership of the value, you can use ManuallyDrop::into_inner instead.

Safety

This function runs the destructor of the contained value. Other than changes made by the destructor itself, the memory is left unchanged, and so as far as the compiler is concerned still holds a bit-pattern which is valid for the type T.

However, this "zombie" value should not be exposed to safe code, and this function should not be called more than once. To use a value after it’s been dropped, or drop a value multiple times, can cause Undefined Behavior (depending on what drop does). This is normally prevented by the type system, but users of ManuallyDrop must uphold those guarantees without assistance from the compiler.

Trait Implementations

source

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

source

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

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

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

source

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

Formats the value using the given formatter. Read more

source

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

source

fn default() -> ManuallyDrop<T>

Returns the "default value" for a type. Read more

const: unstable · source

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

type Target = T

The resulting type after dereferencing.

const: unstable · source

fn deref(&self) -> &T

Dereferences the value.

const: unstable · source

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

const: unstable · source

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

Mutably dereferences the value.

source

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

source

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

Feeds this value into the given Hasher. Read more

1.3.0 · source

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

Feeds a slice of this type into the given Hasher. Read more

source

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

source

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

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

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

Restrict a value to a certain interval. Read more

source

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

source

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

This method tests for self and other values to be equal, and is used by ==. Read more

source

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

This method tests for !=.

source

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

source

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

This method returns an ordering between self and other values if one exists. Read more

1.0.0 · source

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

This method tests less than (for self and other) and is used by the < operator. Read more

1.0.0 · source

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more

1.0.0 · source

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

This method tests greater than (for self and other) and is used by the > operator. Read more

1.0.0 · source

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

This method tests greater than or equal to (for self and other) and is used by the >= operator. Read more

source

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

source

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

source

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

source

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