terminate 0.1.0

A simple crate to abstract logic to terminate threads, coroutines and the like.
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

// This file is part of terminate. It is subject to the license terms in the COPYRIGHT file found in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/terminate/master/COPYRIGHT. No part of terminate, including this file, may be copied, modified, propagated, or distributed except according to the terms contained in the COPYRIGHT file.
// Copyright © 2019 The developers of terminate. See the COPYRIGHT file in the top-level directory of this distribution and at https://raw.githubusercontent.com/lemonrock/terminate/master/COPYRIGHT.


/// Simple implementation of Terminate.
#[derive(Default, Debug)]
pub struct SimpleTerminate
{
	terminate: AtomicBool,
	terminated_due_to_panic_or_irrecoverable_error: AtomicBool,
}

impl Terminate for SimpleTerminate
{
	#[inline(always)]
	fn begin_termination(&self)
	{
		self.terminate.store(true, Relaxed)
	}

	#[inline(always)]
	fn begin_termination_due_to_panic(&self, _panic_info: &PanicInfo)
	{
		self.set_terminated_due_to_panic_or_irrecoverable_error();
		self.begin_termination()
	}

	#[inline(always)]
	fn begin_termination_due_to_irrecoverable_error(&self, _irrecoverable_error: &(dyn Any + Send))
	{
		self.set_terminated_due_to_panic_or_irrecoverable_error();
		self.begin_termination()
	}

	#[inline(always)]
	fn should_finish(&self) -> bool
	{
		self.terminate.load(Relaxed)
	}

	#[inline(always)]
	fn terminated_due_to_panic_or_irrecoverable_error(&self) -> bool
	{
		self.terminated_due_to_panic_or_irrecoverable_error.load(Relaxed)
	}
}

impl SimpleTerminate
{
	/// Creates a new instance.
	#[inline(always)]
	pub fn new() -> Arc<Self>
	{
		Arc::new
		(
			Self
			{
				terminate: AtomicBool::new(false),
				terminated_due_to_panic_or_irrecoverable_error: AtomicBool::new(false),
			}
		)
	}

	#[inline(always)]
	fn set_terminated_due_to_panic_or_irrecoverable_error(&self)
	{
		self.terminated_due_to_panic_or_irrecoverable_error.store(true, Relaxed);
	}
}