refine 3.0.0

Refine your file collections using Rust!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

use anyhow::{Result, anyhow};
use std::fmt::{Display, Formatter};
use std::sync::atomic::AtomicBool;
use std::sync::{LazyLock, atomic};

static RUNNING_FLAG: LazyLock<AtomicBool> = LazyLock::new(|| AtomicBool::new(true));

/// Check whether the program should continue running.
pub fn is_running() -> bool {
    RUNNING_FLAG.load(atomic::Ordering::Relaxed)
}

/// Check whether the user asked to abort, and if so, return an error which can be propagated.
pub fn aborted() -> Result<()> {
    match is_running() {
        true => Ok(()),
        false => Err(anyhow!("user asked to abort")),
    }
}

/// Return an object that prints an abort marker if the program is aborted.
pub fn display_abort(cond: bool) -> impl Display {
    DisplayAbort { cond }
}

#[derive(Debug, Copy, Clone)]
pub struct DisplayAbort {
    cond: bool,
}

impl Display for DisplayAbort {
    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
        if self.cond && !is_running() {
            write!(f, " (aborted)")?;
        }
        Ok(())
    }
}

/// Install a Ctrl-C handler. It must be called only once.
pub fn install_ctrl_c_handler() {
    let handler = || {
        eprintln!(" aborting...");
        RUNNING_FLAG.store(false, atomic::Ordering::Relaxed);
    };
    if let Err(err) = ctrlc::set_handler(handler) {
        eprintln!("error: set Ctrl-C handler: {err:?}");
    }
}