Enum Prefix

#[repr(i32)]
pub enum Prefix {
    Yocto = -24,
    Zepto = -21,
    Atto = -18,
    Femto = -15,
    Pico = -12,
    Nano = -9,
    Micro = -6,
    Milli = -3,
    Unit = 0,
    Kilo = 3,
    Mega = 6,
    Giga = 9,
    Tera = 12,
    Peta = 15,
    Exa = 18,
    Zetta = 21,
    Yotta = 24,
}

Represents units’ SI prefixes.

Variants

Yocto = -24

“yocto” prefix, 1e-24

Zepto = -21

“zepto” prefix, 1e-21

Atto = -18

“atto” prefix, 1e-18

Femto = -15

“femto” prefix, 1e-15

Pico = -12

“pico” prefix, 1e-12

Nano = -9

“nano” prefix, 1e-9

Micro = -6

“micro” prefix, 1e-6

Milli = -3

“milli” prefix, 1e-3

Unit = 0

unit prefix (empty), 1

Kilo = 3

“kilo” prefix, 1e3

Mega = 6

“mega” prefix, 1e6

Giga = 9

“giga” prefix, 1e9

Tera = 12

“tera” prefix, 1e12

Peta = 15

“peta” prefix, 1e15

Exa = 18

“exa” prefix, 1e18

Zetta = 21

“zetta” prefix, 1e21

Yotta = 24

“yotta” prefix, 1e24

Implementations

impl Prefix

pub fn exponent(&self) -> i32

Returns the exponent e for base.pow(e) to return the total scaling factor. See Base::pow().

For instance,

• if self is -12 (“pico”), then exponent() returns -12 so that Base::B1000.pow(-12) returns the scaling factor 1e-12.

• if self is 3 (“kilo”), then exponent() returns 3 so that Base::B1024.pow(3) returns the scaling factor 1024.

Trait Implementations

impl Clone for Prefix

fn clone(&self) -> Prefix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Prefix

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

Formats the value using the given formatter.

impl Display for Prefix

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

Formats the value using the given formatter.

impl From<&Prefix> for &str

fn from(prefix: &Prefix) -> &'static str

Converts a prefix into its displayable form (&'static str).

Example

use si_scale::prelude::Prefix;

let pfx = Prefix::Tera;
let a_string = format!("value: {} {}B", 1.5, pfx);

assert_eq!(a_string, "value: 1.5 TB");

impl FromStr for Prefix

fn from_str(s: &str) -> Result<Self>

Converts a &str into a Prefix if conversion is successful, otherwise return an Err.

Example

use std::str::FromStr;
use si_scale::prelude::Prefix;
use si_scale::Result;

let actual= Prefix::from_str("y");
let expected = Ok(Prefix::Yocto);
assert_eq!(actual, expected);

type Err = SIUnitsError

The associated error which can be returned from parsing.

impl PartialEq for Prefix

fn eq(&self, other: &Prefix) -> 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<i32> for Prefix

fn try_from(value: i32) -> Result<Self>

Builds a Prefix from a i32 if successful, otherwise returns a SIUnitsError::ExponentParsing() error.

type Error = SIUnitsError

The type returned in the event of a conversion error.

impl Copy for Prefix

impl Eq for Prefix

impl StructuralPartialEq for Prefix