Enum UnitSi

#[non_exhaustive]
pub enum UnitSi {
    Quetta,
    Ronna,
    Yotta,
    Zetta,
    Exa,
    Peta,
    Tera,
    Giga,
    Mega,
    Kilo,
    Hecto,
    Deca,
    None,
    Deci,
    Centi,
    Milli,
    Micro,
    Nano,
    Pico,
    Femto,
    Atto,
    Zepto,
    Yocto,
    Ronto,
    Quecto,
}

Available on crate feature unit only.

SI (metric) unit prefixes.

• https://en.wikipedia.org/wiki/Metric_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.

Quetta

10^30

Ronna

10^27

Yotta

10^24

Zetta

10^21

Exa

10^18

Peta

10^15

Tera

10^12

Giga

10^9

Mega

10^6

Kilo

10^3

Hecto

10^2

Deca

10^1

None

10^0 (no prefix)

Deci

10^-1

Centi

10^-2

Milli

10^-3

Micro

10^-6

Nano

10^-9

Pico

10^-12

Femto

10^-15

Atto

10^-18

Zepto

10^-21

Yocto

10^-24

Ronto

10^-27

Quecto

10^-30

Implementations

impl UnitSi

Aliases.

pub const Q: Self = Self::Quetta

Alias of Quetta.

pub const R: Self = Self::Ronna

Alias of Ronna.

pub const Y: Self = Self::Yotta

Alias of Yotta.

pub const Z: Self = Self::Zetta

Alias of Zetta.

pub const E: Self = Self::Exa

Alias of Exa.

pub const P: Self = Self::Peta

Alias of Peta.

pub const T: Self = Self::Tera

Alias of Tera.

pub const G: Self = Self::Giga

Alias of Giga.

pub const M: Self = Self::Mega

Alias of Mega.

pub const k: Self = Self::Kilo

Alias of Kilo.

pub const K: Self = Self::Kilo

Alias of Kilo (alternative).

pub const h: Self = Self::Hecto

Alias of Hecto.

pub const H: Self = Self::Hecto

Alias of Hecto (alternative).

pub const da: Self = Self::Deca

Alias of Deca.

pub const D: Self = Self::Deca

Alias of Deca (alternative).

pub const d: Self = Self::Deci

Alias of Deci.

pub const c: Self = Self::Centi

Alias of Centi.

pub const m: Self = Self::Milli

Alias of Milli.

pub const u: Self = Self::Micro

Alias of Micro (alternative to µ).

pub const n: Self = Self::Nano

Alias of Nano.

pub const p: Self = Self::Pico

Alias of Pico.

pub const f: Self = Self::Femto

Alias of Femto.

pub const a: Self = Self::Atto

Alias of Atto.

pub const z: Self = Self::Zepto

Alias of Zepto.

pub const y: Self = Self::Yocto

Alias of Yocto.

pub const r: Self = Self::Ronto

Alias of Ronto.

pub const q: Self = Self::Quecto

Alias of Quecto.

impl UnitSi

pub const BASE: i32 = 10i32

The base value for SI unit prefixes.

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

Returns the symbol of the prefix.

Example

assert_eq![UnitSi::Giga.symbol(), "G"];
assert_eq![UnitSi::Micro.symbol(), "µ"];

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 associated with the SI unit prefix.

pub const fn factor(&self) -> f64

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

pub const fn factor_i64(&self) -> i64

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

Negative values represent reciprocal factors, indicating that the unit corresponds to a fractional multiplier (e.g., -1000 represents a factor of 1/1000).

This method only supports the range from Exa to Atto, returning 0 for >= Zetta and for <= Zepto.

pub const fn factor_i128(&self) -> i128

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

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

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

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

Converts a value from one SI 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 SI 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 SI prefix as an f64, returning a tuple of the reduced size and the prefix.

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

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

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

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

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 SI 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 SI 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 SI prefixes as an i128, stopping when the remainder is less than the given threshold.

impl UnitSi

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 UnitSi

fn clone(&self) -> UnitSi

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnitSi

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

Formats the value using the given formatter.

impl Default for UnitSi

fn default() -> UnitSi

Returns the “default value” for a type.

impl From<UnitSi> for f32

fn from(from: UnitSi) -> f32

Converts to this type from the input type.

impl From<UnitSi> for f64

fn from(from: UnitSi) -> f64

Converts to this type from the input type.

impl From<UnitSi> for i128

fn from(from: UnitSi) -> i128

Converts to this type from the input type.

impl From<UnitSi> for i64

fn from(from: UnitSi) -> i64

Converts to this type from the input type.

impl PartialEq for UnitSi

fn eq(&self, other: &UnitSi) -> 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<UnitSi> 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: UnitSi) -> Result<i16, Self::Error>

Performs the conversion.

impl TryFrom<UnitSi> 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: UnitSi) -> Result<i32, Self::Error>

Performs the conversion.

impl TryFrom<UnitSi> 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: UnitSi) -> Result<u128, Self::Error>

Performs the conversion.

impl TryFrom<UnitSi> 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: UnitSi) -> Result<u16, Self::Error>

Performs the conversion.

impl TryFrom<UnitSi> 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: UnitSi) -> Result<u32, Self::Error>

Performs the conversion.

impl TryFrom<UnitSi> 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: UnitSi) -> Result<u64, Self::Error>

Performs the conversion.

impl Unit for UnitSi

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 UnitSi

impl Eq for UnitSi

impl StructuralPartialEq for UnitSi