ManuallyDrop

Struct ManuallyDrop 

Source
pub struct ManuallyDrop<T> { /* private fields */ }
Expand description

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

See ::core::mem::ManuallyDrop for more info.

§Differences with ::core::mem::ManuallyDrop

  • No niches

    The current implementation uses ::core::mem::MaybeUninit to make sure the aliasing and dereferenceableity properties of the inner T are properly disabled.

    The main side-effect of this implementation is that it disables niches, thereby preventing discriminant elision.

    For instance, an Option<ManuallyDrop<bool>> will occupy two bytes rather than one.

  • It does not implement [Structural{Partial,}Eq][::core::marker::StructuralEq].

  • Note that once stdlib’s own ::core::mem::ManuallyDrop properly gets its aliasing/dereferenceableity properties removed, this crate shall be updated to just reëxport it (using a build.rs to prevent MSRV breakage).

    This means that the lack of discriminant elision cannot be relied upon either!

  • Other than that, this is a #[repr(transparent)] wrapper around T, thereby having:

    • equal Layout;
    • equal calling-convention ABI1

  1. this is assuming MaybeUninit<T> has the same ABI as T, as it currently advertises, despite that probably being a bad idea for a “bag of bytes” T-ish wrapper, since it means that padding bytes inside of T won’t be preserved when working with a MaybeUninit<T>. So, if the stdlib were to break the current ABI promise of MaybeUninit to cater to that problem, then this crate would probably do so well, unless the maybe_dangling changes were to make it to the stdlib first. 

Implementations§

Source§

impl<T> ManuallyDrop<T>

Source

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

Wrap a value to be manually dropped.

See ::core::mem::ManuallyDrop::new() for more info.

Source

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

Extracts the value from the ManuallyDrop container.

See ::core::mem::ManuallyDrop::into_inner() for more info.

Source

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

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

See ::core::mem::ManuallyDrop::take() for more info.

Source

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

Manually drops the contained value.

See ::core::mem::ManuallyDrop::drop() for more info.

Trait Implementations§

Source§

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

Source§

fn clone(&self) -> Self

Source§

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

Source§

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

Source§

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

Source§

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

Source§

impl<T> Deref for ManuallyDrop<T>

Source§

fn deref(&self) -> &T

Source§

type Target = T

The resulting type after dereferencing.
Source§

impl<T> DerefMut for ManuallyDrop<T>

Source§

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

Source§

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

1.3.0 · Source§

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

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

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

Source§

fn cmp(&self, other: &Self) -> Ordering

1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

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

Source§

fn eq(&self, other: &Self) -> bool

1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

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

Source§

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

1.0.0 · Source§

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

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

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

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl<T: Copy> Copy for ManuallyDrop<T>

Source§

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

Auto Trait Implementations§

§

impl<T> Freeze for ManuallyDrop<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for ManuallyDrop<T>
where T: RefUnwindSafe,

§

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

§

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

§

impl<T> Unpin for ManuallyDrop<T>
where T: Unpin,

§

impl<T> 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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.