[−][src]Crate byte_unit
Byte Unit
A library for interaction with units of bytes.
The units are B for 1 byte, KB for 1000 bytes, KiB for 1024 bytes, MB for 1000000 bytes, MiB for 1048576 bytes, etc, and up to PiB which is 1125899906842624 bytes.
The data type for storing the size of bytes is u128
, so don't worry about the overflow problem.
Usage
Macros
There are n_*_bytes
macros can be used. The star *
means the unit. For example, n_gb_bytes
can be used to get a n-GB value in bytes.
#[macro_use] extern crate byte_unit; let result = n_gb_bytes!(4); assert_eq!(4000000000u128, result);
You may need to assign a primitive type if the n
is not an integer.
#[macro_use] extern crate byte_unit; let result = n_gb_bytes!(2.5, f64); assert_eq!(2500000000u128, result);
Byte
The Byte
structure can be used for representing a size of bytes.
The from_string
associated function can parse any SIZE string and return a Byte
instance in common usage. The format of a SIZE string is like "123", "123KiB" or "50.84 MB".
extern crate byte_unit; use byte_unit::Byte; let result = Byte::from_string("50.84 MB").unwrap(); assert_eq!(50840000u128, result.get_bytes());
You can also use the from_bytes
and from_unit
associated functions to create a Byte
instance.
extern crate byte_unit; use byte_unit::Byte; let result = Byte::from_bytes(1500000u128); assert_eq!(1500000u128, result.get_bytes());
extern crate byte_unit; use byte_unit::{Byte, ByteUnit}; let result = Byte::from_unit(1500f64, ByteUnit::KB).unwrap(); assert_eq!(1500000u128, result.get_bytes());
AdjustedByte
To change the unit of a Byte
instance, you can use the get_adjusted_unit
method.
extern crate byte_unit; use byte_unit::{Byte, ByteUnit}; let byte = Byte::from_string("123KiB").unwrap(); let adjusted_byte = byte.get_adjusted_unit(ByteUnit::KB); assert_eq!("125.95 KB", adjusted_byte.to_string());
To change the unit of a Byte
instance automatically and appropriately, you can use the get_appropriate_unit
method.
extern crate byte_unit; use byte_unit::Byte; let byte = Byte::from_bytes(1500000u128); let adjusted_byte = byte.get_appropriate_unit(false); assert_eq!("1.50 MB", adjusted_byte.to_string());
extern crate byte_unit; use byte_unit::Byte; let byte = Byte::from_bytes(1500000u128); let adjusted_byte = byte.get_appropriate_unit(true); assert_eq!("1.43 MiB", adjusted_byte.to_string());
The number of fractional digits created by the to_string
method of a AdjustedByte
instance is always 2.
To change the number of fractional digits in the formatted string, you can use the format
method instead.
extern crate byte_unit; use byte_unit::Byte; let byte = Byte::from_bytes(1500000u128); let adjusted_byte = byte.get_appropriate_unit(false); assert_eq!("1.5 MB", adjusted_byte.format(1));
Macros
n_gb_bytes | Convert n GB to bytes. |
n_gib_bytes | Convert n GiB to bytes. |
n_kb_bytes | Convert n KB to bytes. |
n_kib_bytes | Convert n KiB to bytes. |
n_mb_bytes | Convert n MB to bytes. |
n_mib_bytes | Convert n MiB to bytes. |
n_pb_bytes | Convert n PB to bytes. |
n_pib_bytes | Convert n PiB to bytes. |
n_tb_bytes | Convert n TB to bytes. |
n_tib_bytes | Convert n TiB to bytes. |
Structs
AdjustedByte | Generated from the |
Byte | Represent the n-bytes data. Use associated functions: |
Enums
ByteError | Different error types for |
ByteUnit | The unit of bytes. |