shukusai 0.0.0

Festival (music player) internals
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

//---------------------------------------------------------------------------------------------------- General Strings
/// Festival Version
///
/// This is the version of the `Festival`'s internals.
///
/// It uses `CARGO_PKG_VERSION`, or `version` found in `Cargo.toml`.
pub const FESTIVAL_VERSION:  &str = concat!("v", env!("CARGO_PKG_VERSION"));

/// Festival + Version
///
/// Just a string concatenating "Festival" and the current version, e.g: `Festival v1.0.0`
pub const FESTIVAL_NAME_VER: &str = concat!("Festival v", env!("CARGO_PKG_VERSION"));

/// "Festival", a `&'static str`
pub const FESTIVAL:          &str = "Festival";

/// Current `git` commit
pub const COMMIT:            &str = include_str!("commit");

/// Build profile (debug/release)
pub const BUILD:             &str = if cfg!(debug_assertions) { "Debug" } else { "Release" };

/// Copyright notice
pub const COPYRIGHT: &str =
r#"Festival is licensed under the MIT License.
For more information on the project, see link below:
<https://github.com/hinto-janai/festival>"#;

/// Logging separator
///
/// This is used in logging to visually separate some things.
pub const DASH: &str = "--------------------------------------------";

/// Unique `Bincode` header
///
/// The `24` unique bytes our `Bincode` files will start with.
///
/// It is the UTF-8 encoded string `-----BEGIN FESTIVAL-----` as bytes.
///
/// The next byte _should_ be our `xxx_VERSION`, then our actual data.
pub const FESTIVAL_HEADER: [u8; 24] = [
	45, 45, 45, 45, 45,             // -----
	66, 69, 71, 73, 78,             // BEGIN
	32,                             //
	70, 69, 83, 84, 73, 86, 65, 76, // FESTIVAL
	45, 45, 45, 45, 45              // -----
];

/// Current major version of the `Collection`
pub const COLLECTION_VERSION: u8 = 1;

/// Current major version of the `State`
pub const STATE_VERSION: u8 = 1;

// Log messages.
pub(crate) const OK: &str   = " ... \x1b[1;92mOK\x1b[0m";
pub(crate) const SKIP: &str = " ... \x1b[1;97mSKIP\x1b[0m";
pub(crate) const FAIL: &str = " ... \x1b[1;91mFAIL\x1b[0m";

//---------------------------------------------------------------------------------------------------- TESTS
#[cfg(test)]
mod tests {
	use crate::constants::*;

	#[test]
	fn version_is_semver() {
		assert_eq!(FESTIVAL_VERSION.len(), 6);
	}

	#[test]
	fn git_commit_eq_or_gt_40_chars() {
		assert!(COMMIT.len() >= 40);
	}
}