core::mem::ManuallyDrop - Rust
Description: API documentation for the Rust `ManuallyDrop` struct in crate `core`.
Keywords: rust, rustlang, rust-lang, ManuallyDrop

# Struct core::mem::ManuallyDrop 1.20.0[−][src]

    #[lang = "manually_drop"]
    pub struct ManuallyDrop<T> { /* fields omitted */ }

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

This wrapper is 0-cost.

# Examples

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`.
        }
    }Run

## Methods

###

`impl<T> ManuallyDrop<T>`

[src]

####

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

[src]

Wrap a value to be manually dropped.

# Examples

    use std::mem::ManuallyDrop;
    ManuallyDrop::new(Box::new(()));Run

####

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

[src]

Extract the value from the ManuallyDrop container.

# Examples

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

####

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

[src]

Manually drops the contained value.

# Safety

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: Copy> Copy for ManuallyDrop<T>`

[src]

###

`impl<T: Clone> Clone for ManuallyDrop<T>`

[src]

####

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

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

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

[src]

####

`fn fmt(&self, f: &mut Formatter) -> Result`

[src]

Formats the value using the given formatter. Read more

###

`impl<T: Default> Default for ManuallyDrop<T>`

[src]

####

`fn default() -> ManuallyDrop<T>`

[src]

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

###

`impl<T: PartialEq> PartialEq for ManuallyDrop<T>`

[src]

####

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

[src]

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

####

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

[src]

This method tests for `!=`.

###

`impl<T: Eq> Eq for ManuallyDrop<T>`

[src]

###

`impl<T: PartialOrd> PartialOrd for ManuallyDrop<T>`

[src]

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

####

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

[src]

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

###

`impl<T: Ord> Ord for ManuallyDrop<T>`

[src]

####

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

[src]

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

####

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

1.21.0
[src]

Compares and returns the maximum of two values. Read more

####

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

1.21.0
[src]

Compares and returns the minimum of two values. Read more

###

`impl<T: Hash> Hash for ManuallyDrop<T>`

[src]

####

`fn hash<__HT: Hasher>(&self, state: &mut __HT)`

[src]

Feeds this value into the given [`Hasher`]. Read more

####

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

1.3.0
[src]

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

###

`impl<T> Deref for ManuallyDrop<T>`

[src]

#### `type Target = T`

The resulting type after dereferencing.

####

`fn deref(&self) -> &Self::Target`

[src]

Dereferences the value.

###

`impl<T> DerefMut for ManuallyDrop<T>`

[src]

####

`fn deref_mut(&mut self) -> &mut Self::Target`

[src]

Mutably dereferences the value.

## Auto Trait Implementations

###

`impl<T> Send for ManuallyDrop<T> where T: Send,`

###

`impl<T> Sync for ManuallyDrop<T> where T: Sync,`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)