watchexec-events 6.1.0

Watchexec's event types
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

#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[non_exhaustive]
/// A keyboard input.
pub enum Keyboard {
	/// Event representing an 'end of file' on stdin
	Eof,

	/// A key press in interactive mode
	Key {
		/// The key that was pressed.
		key: KeyCode,

		/// Modifier keys held during the press.
		#[cfg_attr(
			feature = "serde",
			serde(default, skip_serializing_if = "Modifiers::is_empty")
		)]
		modifiers: Modifiers,
	},
}

/// A key code.
#[derive(Debug, Clone, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "kebab-case"))]
#[non_exhaustive]
pub enum KeyCode {
	/// A unicode character (letter, digit, symbol, space).
	Char(char),
	/// Enter / Return.
	Enter,
	/// Escape.
	Escape,
}

/// Modifier key flags.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Modifiers {
	/// Ctrl / Control was held.
	#[cfg_attr(feature = "serde", serde(default, skip_serializing_if = "is_false"))]
	pub ctrl: bool,
	/// Alt / Option was held.
	#[cfg_attr(feature = "serde", serde(default, skip_serializing_if = "is_false"))]
	pub alt: bool,
	/// Shift was held.
	#[cfg_attr(feature = "serde", serde(default, skip_serializing_if = "is_false"))]
	pub shift: bool,
}

#[cfg(feature = "serde")]
fn is_false(b: &bool) -> bool {
	!b
}

impl Modifiers {
	/// Returns true if no modifier keys are set.
	#[must_use]
	pub fn is_empty(&self) -> bool {
		!self.ctrl && !self.alt && !self.shift
	}
}