Docs4dev
Docs
rust / latest / std / mem / struct.manuallydrop.html

Struct std::mem::ManuallyDrop

pub struct ManuallyDrop<T>
where
    T: ?Sized,{ /* private fields */ }

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 and bit validity 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,
}

Implementations

source 
impl<T> ManuallyDrop<T>
const: 1.32.0source 
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
const: 1.32.0source 
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`.
1.42.0source 
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.0source 
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
source 
impl<T> Deref for ManuallyDrop<T>
where
    T: ?Sized,
 
type Target = T
The resulting type after dereferencing.
source 
fn deref(&self) -> &T
Dereferences the value.
source 
impl<T> DerefMut for ManuallyDrop<T>
where
    T: ?Sized,
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
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
source 
impl<T> PartialEq for ManuallyDrop<T>
where
    T: PartialEq + ?Sized,
source 
fn eq(&self, other: &ManuallyDrop<T>) -> bool
This method tests for self and other values to be equal, and is used by ==.
1.0.0source 
fn ne(&self, other: &Rhs) -> bool
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source 
impl<T> PartialOrd for ManuallyDrop<T>
where
    T: PartialOrd + ?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.0source 
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.0source 
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.0source 
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.0source 
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,

Auto Trait Implementations

impl<T: ?Sized> RefUnwindSafe for ManuallyDrop<T>
where
    T: RefUnwindSafe,
impl<T: ?Sized> Send for ManuallyDrop<T>
where
    T: Send,
impl<T: ?Sized> Sync for ManuallyDrop<T>
where
    T: Sync,
impl<T: ?Sized> Unpin for ManuallyDrop<T>
where
    T: Unpin,
impl<T: ?Sized> UnwindSafe for ManuallyDrop<T>
where
    T: UnwindSafe,

Blanket Implementations

source 
impl<T> Any for T
where
    T: 'static + ?Sized,
source 
fn type_id(&self) -> TypeId
Gets the TypeId of self. Read more
source 
impl<T> Borrow<T> for T
where
    T: ?Sized,
source 
fn borrow(&self) -> &T
Immutably borrows from an owned value. Read more
source 
impl<T> BorrowMut<T> for T
where
    T: ?Sized,
source 
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source 
impl<T> From<T> for T
source 
fn from(t: T) -> T

Returns the argument unchanged.

source 
impl<T, U> Into<U> for T
where
    U: From<T>,
source 
fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source 
impl<T> ToOwned for T
where
    T: Clone,
 
type Owned = T
The resulting type after obtaining ownership.
source 
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
source 
fn clone_into(&self, target: &mut T)
Uses borrowed data to replace owned data, usually by cloning. Read more
source 
impl<T, U> TryFrom<U> for T
where
    U: Into<T>,
 
type Error = Infallible
The type returned in the event of a conversion error.
source 
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
Performs the conversion.
source 
impl<T, U> TryInto<U> for T
where
    U: TryFrom<T>,
 
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
source 
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
Performs the conversion.

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/mem/struct.ManuallyDrop.html