Skip to main content

Bomb

Struct Bomb 

Source
pub struct Bomb<F: FnOnce()> {
    callback: Option<F>,
}
Expand description

Runs f when dropped — like defer — unless it has been defused first.

Handy for “do this unless we get there cleanly”: arm the bomb, then defuse it on every success path, so f runs only when the bomb is dropped early — e.g. an owning task is cancelled, or a ?/panic unwinds past it.

For the common “this must happen before drop, or it is a bug” case, see Bomb::panic.

Fields§

§callback: Option<F>

Implementations§

Source§

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

Source

pub fn new(f: F) -> Self

Arms a bomb that runs f when dropped.

Source

pub fn defuse(&mut self)

Defuses the bomb so f will not run (dropping f, and so releasing whatever it captured).

Source§

impl Bomb<Box<dyn FnOnce()>>

Source

pub fn panic(msg: impl FnOnce() -> String + 'static) -> Self

Arms a bomb that logs msg and then panics when dropped (unless the thread is already panicking) — i.e. asserts that the bomb is defused before it is dropped.

Trait Implementations§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

Auto Trait Implementations§

§

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

§

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

§

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

§

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

§

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

§

impl<F> UnsafeUnpin for Bomb<F>
where F: UnsafeUnpin,

§

impl<F> UnwindSafe for Bomb<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,