Struct CancelGuard 

pub struct CancelGuard<C: Cancellable> { /* private fields */ }

A guard that cancels a source when dropped, unless disarmed.

This provides RAII-style cancellation for cleanup on error paths or panics. Create one via the StopDropRoll trait.

Example

use almost_enough::{Stopper, StopDropRoll};

let source = Stopper::new();

{
    let guard = source.stop_on_drop();
    // guard dropped here, source gets cancelled
}

assert!(source.is_cancelled());

Disarming

Call disarm() to prevent cancellation:

use almost_enough::{Stopper, StopDropRoll};

let source = Stopper::new();

{
    let guard = source.stop_on_drop();
    guard.disarm(); // Prevents cancellation
}

assert!(!source.is_cancelled());

Implementations

impl<C: Cancellable> CancelGuard<C>

pub fn new(source: C) -> Self

Create a new guard that will cancel the source on drop.

Prefer using StopDropRoll::stop_on_drop() instead.

pub fn disarm(self)

Disarm the guard, preventing cancellation on drop.

Call this when the guarded operation succeeds and you don’t want to cancel.

Example

use almost_enough::{Stopper, StopDropRoll};

let source = Stopper::new();
let guard = source.stop_on_drop();

// Operation succeeded, don't cancel
guard.disarm();  // Consumes guard, preventing cancellation

assert!(!source.is_cancelled());

pub fn is_armed(&self) -> bool

Check if this guard is still armed (will cancel on drop).

pub fn source(&self) -> Option<&C>

Get a reference to the underlying source, if still armed.

Trait Implementations

impl<C: Debug + Cancellable> Debug for CancelGuard<C>

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

Formats the value using the given formatter.

impl<C: Cancellable> Drop for CancelGuard<C>

fn drop(&mut self)

Executes the destructor for this type.