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
/*
Appellation: primitives <module>
Contrib: FL03 <jo3mccain@icloud.com>
Description: ... Summary ...
*/
#[doc(inline)]
pub use self::{constants::*, types::*};
/// Type alias for [anyhow::Result]
pub type Result<T = ()> = anyhow::Result<T>;
pub(crate) mod constants {
pub const SCASE: &str = "snake_case";
///
pub const DEFAULT_HTTP_PORT: u16 = 8080;
///
pub const DEFAULT_IGNORE_CHARS: &[char] = &['[', ']', ',', '.', ' '];
/// Localhost in compatible array
pub const LOCALHOST: [u8; 4] = [127, 0, 0, 1];
/// Localhost as [&str]
pub const LOCALHOST_STR: &str = "127.0.0.1";
}
pub(crate) mod types {
use std::{
collections::HashMap,
sync::{Arc, Mutex},
};
pub use config::{AsyncConfigBuilder, ConfigBuilder, ConfigError};
/// Type alias for async errors
pub type AsyncError = Box<dyn std::error::Error + Send + Sync>;
/// Type alias for async results
pub type AsyncResult<T = ()> = Result<T, AsyncError>;
/// Type alias for a boxed error with send, sync, and static flags enabled
pub type BoxError = Box<dyn std::error::Error>;
/// Type alias for the standard result used
pub type BoxResult<T = (), E = BoxError> = Result<T, E>;
/// Type alias for [bson::DateTime]
pub type BsonDateTime = bson::DateTime;
/// Type alias for [bson::oid::ObjectId]
pub type BsonOid = bson::oid::ObjectId;
/// Type alias for [config::Environment]
pub type ConfigEnvironment = config::Environment;
/// Type alias for [config::File]
pub type ConfigFile<Src, Fmt> = config::File<Src, Fmt>;
/// Type alias for a collection of [crate::ConfigFile]
pub type ConfigFileVec = Vec<ConfigFile<config::FileSourceFile, config::FileFormat>>;
/// Type alias for a configuration result
pub type ConfigResult<T> = Result<T, config::ConfigError>;
/// Type alias for [std::collections::HashMap] defaulting to a (String, String) type
pub type Dictionary<K = String, V = String> = HashMap<K, V>;
/// Type alias for [chrono::DateTime]
pub type ChronoDateTime<T = DefaultTimezone> = chrono::DateTime<T>;
/// Type alias for [config::ConfigBuilder]
pub type DefaultConfigBuilder = super::ConfigBuilder<DefaultConfigBuilderState>;
/// Type alias for [config::builder::DefaultState]
pub type DefaultConfigBuilderState = config::builder::DefaultState;
/// Type alias for the default timestamp
pub type DefaultTimestamp = i64;
/// Type alias for the default timezone, [chrono::Utc]
pub type DefaultTimezone = chrono::Utc;
/// Type alias wrapping a locked, thread-safe structure with a [std::sync::Mutex] in an [std::sync::Arc]
pub type Locked<T> = Arc<Mutex<T>>;
/// Type alias for [std::io::Result]
pub type IOResult<T = ()> = std::io::Result<T>;
/// Type alias for a stateful hash map
pub type StateMap<Hs, V = (usize, usize)> = HashMap<Hs, V>;
}