Struct BoxedStop 

pub struct BoxedStop(/* private fields */);

👎Deprecated since 0.4.5:

use StopToken, which checks the same way and is Clone

A type-erased Stop with unique ownership. Deprecated: use StopToken, which checks the same way and is Clone.

BoxedStop wraps a StopToken: no-op stops (like Unstoppable) are stored as nothing and never dispatched, a Stopper is checked as a direct atomic load without a vtable, a SyncStopper keeps its own Arc behind the vtable, and wrapping a StopToken or another BoxedStop reuses it instead of nesting. Anything else is allocated and checked through a vtable.

Example

use almost_enough::{BoxedStop, StopSource, Stopper, Unstoppable, Stop};

fn process(stop: BoxedStop) {
    for i in 0..1000 {
        if i % 100 == 0 && stop.should_stop() {
            return;
        }
        // process...
    }
}

// Works with any Stop implementation
process(BoxedStop::new(Unstoppable));
process(BoxedStop::new(StopSource::new()));
process(BoxedStop::new(Stopper::new()));

Implementations

impl BoxedStop

pub fn new<T: Stop + 'static>(stop: T) -> Self

Create a new boxed stop from any Stop implementation.

No-op stops (where may_stop() returns false) are not allocated — check() will short-circuit to Ok(()). See StopToken::new for the other cases that don’t allocate.

Trait Implementations

impl Debug for BoxedStop

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

Formats the value using the given formatter.

impl Stop for BoxedStop

fn check(&self) -> Result<(), StopReason>

Check if the operation should stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.

fn may_stop(&self) -> bool

Returns true if this stop can ever signal a stop.