cuprated/
constants.rs

1//! General constants used throughout `cuprated`.
2use std::time::Duration;
3
4use const_format::formatcp;
5
6/// `cuprated`'s semantic version (`MAJOR.MINOR.PATCH`) as string.
7pub const VERSION: &str = clap::crate_version!();
8
9/// Major version number of `cuprated`.
10pub const MAJOR_VERSION: &str = env!("CARGO_PKG_VERSION_MAJOR");
11
12/// Major version number of `cuprated`.
13pub const MINOR_VERSION: &str = env!("CARGO_PKG_VERSION_MINOR");
14
15/// Patch version number of `cuprated`.
16pub const PATCH_VERSION: &str = env!("CARGO_PKG_VERSION_PATCH");
17
18/// [`VERSION`] + the build type.
19///
20/// If a debug build, the suffix is `-debug`, else it is `-release`.
21pub const VERSION_BUILD: &str = formatcp!("{VERSION}-{}", cuprate_constants::build::BUILD);
22
23/// The panic message used when cuprated encounters a critical service error.
24pub const PANIC_CRITICAL_SERVICE_ERROR: &str =
25    "A service critical to Cuprate's function returned an unexpected error.";
26
27pub const DEFAULT_CONFIG_WARNING: &str = formatcp!(
28    "WARNING: no config file found, using default config.\
29    \nThe default config may not be optimal for your setup, see the user book here: https://user.cuprate.org/.\
30    \nPausing startup for {} seconds. \
31    \nUse the `--skip-config-warning` arg to skip this delay if you really want to use the default.",
32    DEFAULT_CONFIG_STARTUP_DELAY.as_secs()
33);
34
35pub const DEFAULT_CONFIG_STARTUP_DELAY: Duration = Duration::from_secs(15);
36
37#[cfg(test)]
38mod test {
39    use super::*;
40    use crate::config::Config;
41
42    #[test]
43    fn version() {
44        let semantic_version = format!("{MAJOR_VERSION}.{MINOR_VERSION}.{PATCH_VERSION}");
45        assert_eq!(VERSION, VERSION);
46        assert_eq!(VERSION, "0.0.2");
47    }
48
49    #[test]
50    fn version_build() {
51        if cfg!(debug_assertions) {
52            assert_eq!(VERSION_BUILD, "0.0.2-debug");
53        } else {
54            assert_eq!(VERSION_BUILD, "0.0.2-release");
55        }
56    }
57}