bity 0.1.4

SI prefix, data, packets, data-rate, packet-rate string parser and formater.
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
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

//! [SI prefix](https://en.wikipedia.org/wiki/Metric_prefix), data, packets, data-rate, packet-rate string parser and formater.
//!
//! # Examples
//!
//! ```
//! # use indoc::indoc;
//! # use serde::{Deserialize, Serialize};
//! #
//! assert_eq!(bity::si::parse("5.1M").unwrap(), 5_100_000);
//! assert_eq!(bity::bit::parse("12.34kb").unwrap(), 12_340);
//! assert_eq!(bity::bps::parse("8.65kB/s").unwrap(), 69_200);
//! assert_eq!(bity::byte::parse("55.6kB").unwrap(), 55_600);
//! assert_eq!(bity::byteps::parse("94.5kB/s").unwrap(), 94_500);
//! assert_eq!(bity::packet::parse("3.4kp").unwrap(), 3_400);
//! assert_eq!(bity::pps::parse("2.44Mpps").unwrap(), 2_440_000);
//!
//! assert_eq!(bity::si::format(5_100_000), "5.1M");
//! assert_eq!(bity::bit::format(12_340), "12.34kb");
//! assert_eq!(bity::bps::format(69_200), "69.2kb/s");
//! assert_eq!(bity::byte::format(55_600), "55.6kB");
//! assert_eq!(bity::byteps::format(94_500), "94.5kB/s");
//! assert_eq!(bity::packet::format(3_400), "3.4kp");
//! assert_eq!(bity::pps::format(2_440_000), "2.44Mp/s");
//!
//! #[derive(Serialize, Deserialize, PartialEq, Debug)]
//! #[serde(rename_all = "kebab-case")]
//! struct Config {
//!     #[serde(with = "bity::si")]
//!     max_users: u64,
//!     #[serde(with = "bity::bit")]
//!     user_quota: u64,
//!     #[serde(with = "bity::bps")]
//!     bandwidth: u64,
//!     #[serde(with = "bity::byte")]
//!     disk_size: u64,
//!     #[serde(with = "bity::byteps")]
//!     write_speed: u64,
//!     #[serde(with = "bity::packet")]
//!     remaining: u64,
//!     #[serde(with = "bity::pps")]
//!     record: u64,
//! }
//!
//! assert_eq!(
//!     toml::from_str::<Config>(
//!         r#"
//!         max-users = "1.5k"
//!         user-quota = "5.2Gb"
//!         bandwidth = "512kb/s"
//!         disk-size = "88.1TB"
//!         write-speed = "42.9MB/s"
//!         remaining = "43.88kp"
//!         record = "88.3Mp/s"
//!         "#
//!     )
//!     .unwrap(),
//!     Config {
//!         max_users: 1_500,
//!         user_quota: 5_200_000_000,
//!         bandwidth: 512_000,
//!         disk_size: 88_100_000_000_000,
//!         write_speed: 42_900_000,
//!         remaining: 43_880,
//!         record: 88_300_000,
//!     }
//! );
//!
//! assert_eq!(
//!     toml::to_string(&Config {
//!         max_users: 1_500,
//!         user_quota: 5_200_000_000,
//!         bandwidth: 512_000,
//!         disk_size: 88_100_000_000_000,
//!         write_speed: 42_900_000,
//!         remaining: 43_883,
//!         record: 88_300_000,
//!     })
//!     .unwrap(),
//!     indoc! {
//!         r#"
//!         max-users = "1.5k"
//!         user-quota = "5.2Gb"
//!         bandwidth = "512kb/s"
//!         disk-size = "88.1TB"
//!         write-speed = "42.9MB/s"
//!         remaining = "43.88kp"
//!         record = "88.3Mp/s"
//!         "#
//!     }
//! );
//! ```
//!
//! # Features
//! - No precision loss
//! - Differentiate bits and bytes
//! - `serde` support
//!
//! # Limitations
//! - Only support [metric prefixes](https://en.wikipedia.org/wiki/Metric_prefix),
//!   [IEC prefixes](https://en.wikipedia.org/wiki/Binary_prefix) are not
//!   supported
//! - No customizable formating
//! - `u64` limited (doesn't go above *exa*, aka. `10^18`)

#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#![cfg_attr(not(test), warn(clippy::dbg_macro, clippy::print_stdout))]

pub mod bit;
pub mod bps;
pub mod byte;
pub mod byteps;
mod error;
pub mod packet;
pub mod pps;
#[cfg(feature = "serde")]
mod serde;
pub mod si;

pub use error::Error;

/// Strip at most one per-second prefix such as `/s` or `ps` (per-second).
///
/// # Examples
///
/// ```
/// assert_eq!(bity::strip_per_second("8kb/s"), "8kb");
/// assert_eq!(bity::strip_per_second("8kbps"), "8kb");
///
/// // It will only strip the last per-second occurrence.
/// assert_eq!(bity::strip_per_second("8kbps/s"), "8kbps");
/// ```
pub fn strip_per_second(mut input: &str) -> &str {
    input = input.trim();
    // Don't use `trim` here because we don't want to remove the suffix multiple
    // times.
    input
        .strip_suffix("/s")
        .or_else(|| input.strip_suffix("ps"))
        .unwrap_or(input)
}

#[cfg(test)]
mod tests {
    #[test]
    fn strip_per_second() {
        assert_eq!(super::strip_per_second("whatever/s"), "whatever");
        assert_eq!(super::strip_per_second("whateverps"), "whatever");
        assert_eq!(super::strip_per_second("whatever/s/s"), "whatever/s");
        assert_eq!(super::strip_per_second("whateverpsps"), "whateverps");
        assert_eq!(super::strip_per_second("whateverps/s"), "whateverps");
        assert_eq!(super::strip_per_second("whatever/sps"), "whatever/s");
    }
}