Enum UnitBi

#[non_exhaustive]
pub enum UnitBi {
    Yobi = 80,
    Zebi = 70,
    Exbi = 60,
    Pebi = 50,
    Tebi = 40,
    Gibi = 30,
    Mebi = 20,
    Kibi = 10,
    None = 0,
}

Available on crate feature unit only.

Binary unit prefixes.

• https://en.wikipedia.org/wiki/Binary_prefix

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Yobi = 80

2^80.

Zebi = 70

2^70.

Exbi = 60

2^60.

Pebi = 50

2^50.

Tebi = 40

2^40.

Gibi = 30

2^30.

Mebi = 20

2^20.

Kibi = 10

2^10.

None = 0

2^0 (no prefix).

Implementations

impl UnitBi

Aliases.

pub const Yi: Self = Self::Yobi

Alias of Yobi.

pub const Y: Self = Self::Yobi

Alias of Yobi.

pub const Zi: Self = Self::Zebi

Alias of Zebi.

pub const Z: Self = Self::Zebi

Alias of Zebi.

pub const Ei: Self = Self::Exbi

Alias of Exbi.

pub const E: Self = Self::Exbi

Alias of Exbi.

pub const Pi: Self = Self::Pebi

Alias of Pebi.

pub const P: Self = Self::Pebi

Alias of Pebi.

pub const Ti: Self = Self::Tebi

Alias of Tebi.

pub const T: Self = Self::Tebi

Alias of Tebi.

pub const Gi: Self = Self::Gibi

Alias of Gibi.

pub const G: Self = Self::Gibi

Alias of Gibi.

pub const Mi: Self = Self::Mebi

Alias of Mebi.

pub const M: Self = Self::Mebi

Alias of Mebi.

pub const Ki: Self = Self::Kibi

Alias of Kibi.

pub const k: Self = Self::Kibi

Alias of Kibi.

pub const K: Self = Self::Kibi

Alias of Kibi.

impl UnitBi

pub const BASE: i32 = 2i32

The base value for binary unit prefixes.

pub const fn symbol(&self) -> &str

Returns the symbol of the prefix.

Example

assert_eq![UnitBi::Gibi.symbol(), "Gi"];

pub const fn symbol_ascii(&self) -> &str

Returns the ASCII symbol of the prefix.

pub const fn name(&self) -> &str

Returns the name of the prefix.

pub const fn exp(&self) -> i32

Returns the exponent corresponding to the binary unit prefix.

For example, Mebi corresponds to an exponent of 20, meaning Self::BASE^self.exp() = 1_048_576.

pub const fn factor(&self) -> f64

Returns the multiplication factor for the binary prefix as an f64.

pub const fn factor_i64_checked(&self) -> Option<i64>

Returns the multiplication factor for the binary prefix as an i64.

Only supports the range up to Exbi, returning None for Zebi and Yobi.

pub const fn factor_i64(&self) -> i64

Returns the multiplication factor for the binary prefix as an i64.

Only supports the range up to Exbi, returning 0 for Zebi and Yobi.

pub const fn factor_i128(&self) -> i128

Returns the multiplication factor for the binary prefix as an i128.

pub fn convert(value: f64, from: Self, to: Self) -> f64

Converts a value from one binary prefix to another, returning the converted value.

pub fn convert_i64(value: i64, from: Self, to: Self) -> (i64, i64)

Converts a value from one binary prefix to another, returning the converted value and the remainder.

pub fn convert_i128(value: i128, from: Self, to: Self) -> (i128, i128)

Converts a value from one binary prefix to another, returning the converted value and the remainder.

pub fn reduce(value: f64) -> (f64, Self)

Available on crate features std or _float_f64 only.

Reduces the given value to the most appropriate binary prefix as an f64, returning a tuple of the reduced size and the prefix.

The input value is assumed to be non-negative, and in base units, meaning it has no prefix applied.

This method simplifies large numerical values by scaling them down to the largest appropriate binary prefix (e.g., Kibi, Mebi, Gibi, etc.).

pub const fn reduce_i64(value: i64) -> (i64, Self, i64)

Reduces the given value to the most appropriate binary prefix as an i64, returning a tuple of the reduced size, the prefix, and the remainder.

The input value is assumed to be non-negative, and in base units, meaning it has no prefix applied.

This method simplifies large numerical values by scaling them down to the largest appropriate binary prefix (e.g., Kibi, Mebi, Gibi, etc.).

pub const fn reduce_i128(value: i128) -> (i128, Self, i128)

Reduces the given value to the most appropriate binary prefix as an i128, returning a tuple of the reduced size, the prefix, and the remainder.

The input value is assumed to be non-negative, and in base units, meaning it has no prefix applied.

This method simplifies large numerical values by scaling them down to the largest appropriate binary prefix (e.g., Kibi, Mebi, Gibi, etc.).

pub fn reduce_chain(value: f64, threshold: f64) -> Vec<(f64, Self)>

Available on crate feature std, or crate features alloc and _float_f64 only.

Reduces the given value to a chain of appropriate binary prefixes as an f64, stopping when the remainder is less than the given threshold.

pub fn reduce_chain_i64(value: i64, threshold: i64) -> Vec<(i64, Self)>

Available on crate feature alloc only.

Reduces the given value to a chain of appropriate binary prefixes as an i64, stopping when the remainder is less than the given threshold.

pub fn reduce_chain_i128(value: i128, threshold: i128) -> Vec<(i128, Self)>

Available on crate feature alloc only.

Reduces the given value to a chain of appropriate binary prefixes as an i128, stopping when the remainder is less than the given threshold.

impl UnitBi

pub fn asc_iter() -> impl Iterator<Item = Self>

Returns an iterator in ascending order of magnitude.

pub fn desc_iter() -> impl Iterator<Item = Self>

Returns an iterator in descending order of magnitude.

Trait Implementations

impl Clone for UnitBi

fn clone(&self) -> UnitBi

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnitBi

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for UnitBi

fn default() -> UnitBi

Returns the “default value” for a type.

impl From<UnitBi> for f32

fn from(from: UnitBi) -> f32

Converts to this type from the input type.

impl From<UnitBi> for f64

fn from(from: UnitBi) -> f64

Converts to this type from the input type.

impl From<UnitBi> for i128

fn from(from: UnitBi) -> i128

Converts to this type from the input type.

impl From<UnitBi> for i64

fn from(from: UnitBi) -> i64

Converts to this type from the input type.

impl PartialEq for UnitBi

fn eq(&self, other: &UnitBi) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<UnitBi> for i16

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<i16, Self::Error>

Performs the conversion.

impl TryFrom<UnitBi> for i32

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<i32, Self::Error>

Performs the conversion.

impl TryFrom<UnitBi> for u128

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<u128, Self::Error>

Performs the conversion.

impl TryFrom<UnitBi> for u16

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<u16, Self::Error>

Performs the conversion.

impl TryFrom<UnitBi> for u32

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<u32, Self::Error>

Performs the conversion.

impl TryFrom<UnitBi> for u64

Available on crate feature cast only.

type Error = NumError

The type returned in the event of a conversion error.

fn try_from(from: UnitBi) -> Result<u64, Self::Error>

Performs the conversion.

impl Unit for UnitBi

const BASE: Option<i32>

The base value for unit prefixes.

fn symbol(&self) -> &str

Returns the symbol of the prefix.

fn symbol_ascii(&self) -> &str

Returns the ASCII symbol of the prefix.

fn name(&self) -> &str

Returns the name of the prefix.

fn factor(&self) -> f64

Returns the multiplication factor for the prefix as an f64.

fn factor_i64(&self) -> i64

Returns the multiplication factor for the prefix as an i64.

fn factor_i128(&self) -> i128

Returns the multiplication factor for the prefix as an i128.

fn asc_iter() -> impl Iterator<Item = Self>

Returns an iterator in ascending order of magnitude.

fn desc_iter() -> impl Iterator<Item = Self>

Returns an iterator in descending order of magnitude.

fn exp(&self) -> Option<i32>

Returns the exponent corresponding to the unit prefix.

fn convert(value: f64, from: Self, to: Self) -> f64

Converts a value from one unit prefix variant to another, returning the converted value.

fn convert_i64(value: i64, from: Self, to: Self) -> (i64, i64)

Converts a value from one prefix to another, returning the converted value and the remainder.

fn convert_i128(value: i128, from: Self, to: Self) -> (i128, i128)

Converts a value from one prefix to another, returning the converted value and the remainder.

fn reduce(value: f64) -> (f64, Self)

Reduces the given value to the most appropriate prefix as a f64, returning a tuple of the reduced size and the prefix.

fn reduce_i64(value: i64) -> (i64, Self, i64)

Reduces the given value to the most appropriate prefix as a i64, returning a tuple of the reduced size, the prefix, and the remainder.

fn reduce_i128(value: i128) -> (i128, Self, i128)

Reduces the given value to the most appropriate prefix as a i128, returning a tuple of the reduced size, the prefix, and the remainder.

fn reduce_chain(value: f64, threshold: f64) -> Vec<(f64, Self)>

Reduces the given value to a chain of appropriate prefixes as f64, stopping when the remainder is less than the given threshold.

fn reduce_chain_i64(value: i64, threshold: i64) -> Vec<(i64, Self)>

Reduces the given value to a chain of appropriate prefixes as i64, stopping when the remainder is less than the given threshold.

fn reduce_chain_i128(value: i128, threshold: i128) -> Vec<(i128, Self)>

Reduces the given value to a chain of appropriate prefixes as i128, stopping when the remainder is less than the given threshold.

impl Copy for UnitBi

impl Eq for UnitBi

impl StructuralPartialEq for UnitBi