Struct bevy_utils::OnDrop

source ·
pub struct OnDrop<F: FnOnce()> { /* private fields */ }
Expand description

A type which calls a function when dropped. This can be used to ensure that cleanup code is run even in case of a panic.

Note that this only works for panics that unwind – any code within OnDrop will be skipped if a panic does not unwind. In most cases, this will just work.

§Examples

// This will print a message when the variable `_catch` gets dropped,
// even if a panic occurs before we reach the end of this scope.
// This is similar to a `try ... catch` block in languages such as C++.
let _catch = OnDrop::new(|| log("Oops, a panic occurred and this function didn't complete!"));

// Some code that may panic...
// ...

// Make sure the message only gets printed if a panic occurs.
// If we remove this line, then the message will be printed regardless of whether a panic occurs
// -- similar to a `try ... finally` block.
std::mem::forget(_catch);

Implementations§

source§

impl<F: FnOnce()> OnDrop<F>

source

pub fn new(callback: F) -> Self

Returns an object that will invoke the specified callback when dropped.

Trait Implementations§

source§

impl<F: FnOnce()> Drop for OnDrop<F>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

impl<F> Freeze for OnDrop<F>
where F: Freeze,

§

impl<F> RefUnwindSafe for OnDrop<F>
where F: RefUnwindSafe,

§

impl<F> Send for OnDrop<F>
where F: Send,

§

impl<F> Sync for OnDrop<F>
where F: Sync,

§

impl<F> Unpin for OnDrop<F>
where F: Unpin,

§

impl<F> UnwindSafe for OnDrop<F>
where F: 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> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, 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.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

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