rx_core_common 0.2.2

rx_core's core traits and implementations
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

use core::{fmt::Debug, ops::AddAssign};

use crate::{WithWorkContextProvider, WithWorkInputOutput, WorkContextProvider};

pub trait ScheduledWork: WithWorkInputOutput + WithWorkContextProvider {
	fn tick(
		&mut self,
		input: Self::Tick,
		context: &mut <Self::WorkContextProvider as WorkContextProvider>::Item<'_>,
	) -> WorkResult;

	/// This hook is called once when the work enters the executor during the
	/// first tick after being scheduled.
	fn on_scheduled_hook(&mut self, tick_input: Self::Tick);
}

#[derive(Debug)]
pub enum WorkResult {
	/// Work that is done will be immediately removed from the scheduler
	Done,
	/// Pending work will be kept in the scheduler
	Pending,
}

impl AddAssign for WorkResult {
	fn add_assign(&mut self, rhs: Self) {
		let change = match self {
			Self::Pending => Some(rhs),
			Self::Done => match rhs {
				Self::Pending => None,
				_ => Some(rhs),
			},
		};

		if let Some(change) = change {
			*self = change;
		}
	}
}