blackhole 0.20.2

...to throw your threads into.
Documentation 
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
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

/*
==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--==--

Black Hole

Copyright (C) 2019-2020, 2022-2023  Anonymous

There are several releases over multiple years,
they are listed as ranges, such as: "2019-2020".

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--::--
*/

//! # Job

/// # A job to be used by [`BlackHole`][crate:BlackHole]
///
/// ## Usage
///
/// You can return new job from [`::run()`][::run()] for it to be run.
///
/// [crate:BlackHole]: struct.BlackHole.html
/// [::run()]: trait.Job.html#tymethod.run
pub trait Job: Send + 'static {

    /// # Runs the job
    fn run(&mut self) -> Option<Box<dyn Job>>;

}

/// # Runs a job to the end
pub fn run_to_end<J>(mut job: J) where J: Job {
    let mut job = job.run();
    while let Some(mut new_job) = job {
        job = new_job.run();
    }
}

/// # A job that runs once
///
/// ## Panics
///
/// It will panic if run more than once.
///
/// ## Examples
///
/// ```
/// use blackhole::{BlackHole, OneTime};
///
/// let black_hole = BlackHole::make(8).unwrap();
/// for i in 0..10 {
///     match black_hole.throw(OneTime::new(move || println!("{}", i))) {
///         Ok(job) => if let Some(job) = job {
///             blackhole::run_to_end(job);
///         },
///         Err(err) => eprintln!("BlackHole... exploded: {}", err),
///     };
/// }
/// black_hole.escape_on_idle().unwrap();
/// ```
#[derive(Debug)]
pub struct OneTime<F> where F: FnOnce() + Send + 'static {

    /// # The job
    f: Option<F>,

}

impl<F> OneTime<F> where F: FnOnce() + Send + 'static {

    /// # Makes new instance
    pub fn new(f: F) -> Self {
        Self {
            f: Some(f),
        }
    }

}

impl<F> Job for OneTime<F> where F: FnOnce() + Send + 'static {

    fn run(&mut self) -> Option<Box<dyn Job>> {
        self.f.take().expect("OneTime job must be run at most once")();
        None
    }

}

#[test]
fn test_one_time() {
    use std::sync::{
        Arc,
        atomic::{self, AtomicBool},
    };

    const ORDERING: atomic::Ordering = atomic::Ordering::Relaxed;

    let data = Arc::new(AtomicBool::new(false));
    run_to_end({
        let data = data.clone();
        OneTime::new(move || data.store(true, ORDERING))
    });
    assert!(data.load(ORDERING));
}