Struct FnStop 

pub struct FnStop<F> { /* private fields */ }

A Stop implementation backed by a closure.

The closure should return true when the operation should stop.

Example

use almost_enough::{FnStop, Stop};
use core::sync::atomic::{AtomicBool, Ordering};

let flag = AtomicBool::new(false);
let stop = FnStop::new(|| flag.load(Ordering::Relaxed));

assert!(!stop.should_stop());

flag.store(true, Ordering::Relaxed);
assert!(stop.should_stop());

Implementations

impl<F> FnStop<F>

where F: Fn() -> bool + Send + Sync,

pub fn new(f: F) -> Self

Create a new function-based stop.

The function should return true when the operation should stop.

Trait Implementations

impl<F: Clone> Clone for FnStop<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F> Debug for FnStop<F>

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

Formats the value using the given formatter.

impl<F> Stop for FnStop<F>

where F: Fn() -> bool + Send + Sync,

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

Check if the operation should stop.

fn should_stop(&self) -> bool

Returns true if the operation should stop.

impl<F: Copy> Copy for FnStop<F>