Struct dispose::Disposable

pub struct Disposable<T: Dispose>(_);

Wrapper for values implementing Dispose that provides a Drop implementation.

This struct will automatically consume its contents on drop using the provided Dispose implementation.

See this page for example usage.

Implementations

impl<T: Dispose> Disposable<T>

pub fn new(val: T) -> Self

Construct a new Disposable instance, wrapping around val.

pub unsafe fn leak(this: Self) -> T

Consume the wrapper, producing the contained value.

Safety

It is up to the user to ensure the value does not fall out of scope without being consumed.

The value can be safely re-inserted into a Disposable using Disposable::new to restore safe drop behavior, and it is recommended that the value is held by some container which consumes it on drop at all times. The intended use case for this function is transferring the value from one container to the other.

Trait Implementations

impl<T: Dispose> AsMut<T> for Disposable<T>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: Dispose> AsRef<T> for Disposable<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: Dispose> Borrow<T> for Disposable<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T: Dispose> BorrowMut<T> for Disposable<T>

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

Mutably borrows from an owned value.

impl<T: Debug + Dispose> Debug for Disposable<T>

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

Formats the value using the given formatter.

impl<T: Dispose> Deref for Disposable<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Dispose> DerefMut for Disposable<T>

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

Mutably dereferences the value.

impl<T: Dispose> Drop for Disposable<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Dispose> From<T> for Disposable<T>

fn from(val: T) -> Self

Converts to this type from the input type.