Struct Halt 

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

Clonable, infallible cooperative-cancellation token.

Clones share the same underlying flag. cancel() is one-way; there is no reset() by design — construct a fresh Halt for a fresh operation.

Construct with Halt::new (or Halt::default). The Default impl forwards to new() — both produce a fresh, uncancelled token. The pair exists because clippy’s new_without_default lint requires Default whenever a public new() is present, even when the two would do exactly the same thing.

Implementations

impl Halt

pub fn new() -> Self

Construct a fresh, uncancelled token.

pub fn from_arc(flag: Arc<AtomicBool>) -> Self

Wrap an existing Arc<AtomicBool> as a Halt. Useful as a bridge during the 0.18 deprecation window: callers that already hold an Arc<AtomicBool> (e.g. Drive::halt_flag(), the deprecated DiscStream::set_halt) can adopt the new token API without changing the underlying flag.

Cancelling either side flips the same bit — the wrapping Halt and the original Arc are two views over one shared flag.

pub fn as_arc(&self) -> &Arc<AtomicBool>

Borrow the underlying Arc<AtomicBool>. Used at boundaries with pre-Halt APIs that still take an Arc<AtomicBool> directly (CopyOptions::halt, the deprecated DiscStream::set_halt). Round 3 deletes those boundaries and this accessor with them.

pub fn cancel(&self)

Flip the shared flag to cancelled. Idempotent.

pub fn is_cancelled(&self) -> bool

Read the shared flag.

Trait Implementations

impl Clone for Halt

fn clone(&self) -> Halt

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Halt

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

Formats the value using the given formatter.

impl Default for Halt

fn default() -> Self

Returns the “default value” for a type.