Struct Revertible

pub struct Revertible<F>
where
    F: FnOnce() + Send + 'static,
{ /* private fields */ }

A revertible action.

Returned by several functions registering callbacks that may have to be unregistered later. This type is marked as must_use to force being explicit about handling reversions.

There several ways to deal with a received Revertible:

• Call revert_on_unload to automatically revert on addon unload.
• Call leak or drop it (explicitly or implicitly) to discard and unregister manually.
• Keep the Revertible and call revert later.
• Turn it into a callable via into_inner and call it later.

Implementations

impl<F> Revertible<F>

where F: FnOnce() + Send + 'static,

pub const fn new(revert: F) -> Self

Creates a new revertible action.

pub fn into_inner(self) -> F

Turns the revertible into the inner callable.

pub fn leak(self)

Leaves the action to not be reverted.

The reversion has to be performed manually. Effectively the same as dropping the revertible.

pub fn revert(self)

Reverts the action.

pub fn revert_on_unload(self)

Submits the revertible to be reverted on unload.

Trait Implementations

impl<F> Debug for Revertible<F>

where F: FnOnce() + Send + 'static + Debug,

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

Formats the value using the given formatter.

impl<F> From<F> for Revertible<F>

where F: FnOnce() + Send + 'static,

fn from(revert: F) -> Self

Converts to this type from the input type.