bsize 0.1.0-rc.3

Semantic wrappers and utilities for byte size representations.
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

// Copyright 2026 FastLabs Developers
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

//! `BSize` provides multiple semantic wrappers and utilities for byte size representations.
//!
//! # Features
//!
//! * `#![no_std]`-capable, no dependencies, and uses no heap allocation.
//! * `BSize` wrappers over `u8`, `u16`, `u32`, `u64`, and `usize` for representing byte sizes with
//!   different underlying types.
//! * `FromStr` impl for `BSize`, allowing for parsing string size representations like "1.5KiB" and
//!   "521TiB".
//! * `Display` impl for `BSize`, allowing for formatting byte sizes as human-readable strings in
//!   both binary (e.g., "1.5 MiB") and decimal (e.g., "1.5 MB") styles.
//! * Serde support for binary and human-readable deserializers like JSON.
//!
//! # Examples
//!
//! Construction using the binary or decimal constant helpers.
//!
//! ```
//! use bsize::BSize;
//!
//! assert!(BSize::<usize>::kib(4) > BSize::<usize>::kb(4));
//! ```
//!
//! Display as human-readable string.
//!
//! ```
//! use bsize::BSize;
//!
//! assert_eq!(
//!     "518.0 GiB",
//!     BSize::<usize>::gib(518).display().binary().to_string()
//! );
//! assert_eq!(
//!     "556.2 GB",
//!     BSize::<usize>::gib(518).display().decimal().to_string()
//! );
//! ```
//!
//! Arithmetic operations are supported.
//!
//! ```
//! use bsize::BSize;
//!
//! let plus = BSize::<usize>::mb(1) + BSize::<usize>::kb(100);
//! println!("{plus}");
//!
//! let minus = BSize::<usize>::tb(1) - BSize::<usize>::gb(4);
//! assert_eq!(BSize::<usize>::gb(996), minus);
//! ```
//!
//! Arithmetic operations over the underlying types are supported.
//!
//!```
//! use bsize::BSize;
//!
//! let size = BSize::<usize>::mb(1);
//! let size = size.with(|b| b * 4); // 4x scale
//! println!("{size}");
//! ```

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(missing_docs)]
#![no_std]
extern crate alloc;

mod display;
mod ops;
mod parse;
#[cfg(feature = "serde")]
mod serde;
mod types;
mod unsigned;

pub use self::display::Display;
pub use self::parse::ParseError;
pub use self::types::BSize;
pub use self::unsigned::Unsigned;