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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182
//! Global configuration for this [crate].
//!
//! You may change the configuration by calling [set_config] function.
//!
//! # Example
//! ```rust
//! use tcp_handler::config::{Config, set_config};
//!
//! # fn main() {
//! set_config(Config::default());
//! # }
//! ```
use std::sync::RwLock;
use once_cell::sync::Lazy;
/// Global configuration.
///
/// # Example
/// ```rust
/// use tcp_handler::config::Config;
///
/// # fn main() {
/// let config = Config::default();
/// # let _ = config;
/// # }
/// ```
#[derive(Debug, Clone, Copy, Eq, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Config {
/// `max_packet_size` is the maximum size of a packet in bytes.
/// It is used to limit the size of a packet that can be received or sent.
///
/// Default value is `1 << 20`.
///
/// # Example
/// ```rust
/// use tcp_handler::config::Config;
///
/// # fn main() {
/// let config = Config {
/// max_packet_size: 1 << 10,
/// ..Config::default()
/// };
/// # let _ = config;
/// # }
/// ```
pub max_packet_size: usize,
/// `compression` is the [flate2::Compression] level when sending packets.
///
/// # Example
/// ```rust
/// use tcp_handler::config::Config;
/// use tcp_handler::Compression;
///
/// # fn main() {
/// let config = Config {
/// compression: Compression::fast(),
/// ..Config::default()
/// };
/// # let _ = config;
/// # }
/// ```
#[cfg(feature = "compression")]
#[cfg_attr(docsrs, cfg(feature = "compression"))]
#[cfg_attr(feature = "serde", serde(serialize_with = "serialize_compression", deserialize_with = "deserialize_compression"))]
pub compression: flate2::Compression,
}
#[cfg(feature = "serde")]
fn serialize_compression<S: serde::Serializer>(compression: &flate2::Compression, serializer: S) -> Result<S::Ok, S::Error> {
<u32 as serde::Serialize>::serialize(&(compression.level() as u32), serializer)
}
#[cfg(feature = "serde")]
fn deserialize_compression<'de, D: serde::Deserializer<'de>>(deserializer: D) -> Result<flate2::Compression, D::Error> {
<u32 as serde::Deserialize>::deserialize(deserializer).map(|l| flate2::Compression::new(l))
}
impl Default for Config {
fn default() -> Self {
Self {
max_packet_size: 1 << 20,
#[cfg(feature = "compression")]
compression: flate2::Compression::default(),
}
}
}
static CONFIG: Lazy<RwLock<Config>> = Lazy::new(|| RwLock::new(Config::default()));
/// Set the global configuration.
///
/// This function is recommended to only be called once during initialization.
///
/// # Example
/// ```rust
/// use tcp_handler::config::{Config, set_config};
///
/// # fn main() {
/// set_config(Config::default());
/// # }
/// ```
#[inline]
pub fn set_config(config: Config) {
let mut c = CONFIG.write().unwrap();
*c = config;
}
/// Get the global configuration.
///
/// # Example
/// ```rust
/// use tcp_handler::config::get_config;
///
/// # fn main() {
/// let config = get_config();
/// # let _ = config;
/// # }
/// ```
#[inline]
pub fn get_config() -> Config {
let c = CONFIG.read().unwrap();
(*c).clone()
}
/// A cheaper shortcut of
/// ```rust,ignore
/// get_config().max_packet_size
/// ```
#[inline]
pub fn get_max_packet_size() -> usize {
let c = CONFIG.read().unwrap();
(*c).max_packet_size
}
/// A cheaper shortcut of
/// ```rust,ignore
/// get_config().compression
/// ```
#[cfg(feature = "compression")]
#[cfg_attr(docsrs, cfg(feature = "compression"))]
#[inline]
pub fn get_compression() -> flate2::Compression {
let c = CONFIG.read().unwrap();
(*c).compression
}
#[cfg(test)]
mod test {
use crate::config::*;
#[test]
fn get() {
let _ = get_max_packet_size();
let _ = get_compression();
}
#[test]
fn set() {
set_config(Config { max_packet_size: 1 << 10, ..Config::default() });
assert_eq!(1 << 10, get_max_packet_size());
}
#[test]
fn set_twice() {
set_config(Config { max_packet_size: 1 << 10, ..Config::default() });
assert_eq!(1 << 10, get_max_packet_size());
set_config(Config { max_packet_size: 2 << 10, ..Config::default() });
assert_eq!(2 << 10, get_max_packet_size());
}
#[cfg(feature = "serde")]
#[test]
fn serde() {
let config = Config { max_packet_size: 1 << 10, ..Config::default() };
let serialized = serde_json::to_string(&config).unwrap();
let deserialized: Config = serde_json::from_str(&serialized).unwrap();
assert_eq!(config, deserialized);
}
}