Struct StopRef 

pub struct StopRef<'a> { /* private fields */ }

A borrowed reference to a StopSource.

This is a lightweight reference that can only check for cancellation - it cannot trigger it. Use the source to cancel.

Example

use almost_enough::{StopSource, Stop};

fn process(data: &[u8], stop: impl Stop) {
    for (i, chunk) in data.chunks(100).enumerate() {
        if i % 10 == 0 && stop.should_stop() {
            return;
        }
        // process chunk...
    }
}

let source = StopSource::new();
process(&[0u8; 1000], source.as_ref());

Copy Semantics

StopRef is Copy, so you can freely copy it without cloning:

use almost_enough::{StopSource, Stop};

let source = StopSource::new();
let r1 = source.as_ref();
let r2 = r1;  // Copy
let r3 = r1;  // Still valid

source.cancel();
assert!(r1.should_stop());
assert!(r2.should_stop());
assert!(r3.should_stop());

Trait Implementations

impl<'a> Clone for StopRef<'a>

fn clone(&self) -> StopRef<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for StopRef<'a>

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

Formats the value using the given formatter.

impl Stop for StopRef<'_>

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

Check if the operation should stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.

impl<'a> Copy for StopRef<'a>