Struct StopSource 

pub struct StopSource { /* private fields */ }

A stack-based cancellation source.

This is a zero-allocation cancellation primitive. The source owns the atomic and can issue borrowed references via as_ref().

Example

use almost_enough::{StopSource, Stop};

let source = StopSource::new();
let stop = source.as_ref();

// Check in your operation
assert!(!stop.should_stop());

// Cancel when needed
source.cancel();
assert!(stop.should_stop());

Const Construction

StopSource can be created in const context:

use almost_enough::StopSource;

static GLOBAL_STOP: StopSource = StopSource::new();

Implementations

impl StopSource

pub const fn new() -> Self

Create a new cancellation source.

pub const fn cancelled() -> Self

Create a source that is already cancelled.

Useful for testing or when you want to signal immediate stop.

pub fn cancel(&self)

Signal all references to stop.

A Release swap: writes made before a cancel() are visible to a thread whose is_cancelled returns true after it, even when several threads cancel. On targets without atomic swap (thumbv6m, say) it is a Release store, which guarantees that only for a single canceller. Calling it again changes nothing else.

pub fn is_cancelled(&self) -> bool

Whether this source has been cancelled, as an Acquire load.

When it returns true, this thread also sees every write made before cancel. Checks through a StopRef are Relaxed loads, which promise nothing about other writes.

pub fn as_ref(&self) -> StopRef<'_>

Get a borrowed reference to pass to operations.

The reference borrows from this source, so it cannot outlive it. For owned stops, use Stopper.

pub fn token(&self) -> StopRef<'_>

👎Deprecated since 0.1.0:

use as_ref() instead

Alias for as_ref() for migration from AtomicStop.

Trait Implementations

impl Debug for StopSource

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

Formats the value using the given formatter.

impl Default for StopSource

fn default() -> Self

Returns the “default value” for a type.

impl Stop for StopSource

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.