Enum number_prefix::NumberPrefix

pub enum NumberPrefix<F> {
    Standalone(F),
    Prefixed(Prefix, F),
}

The result of trying to apply a prefix to a floating-point value.

Variants

Standalone(F)

A standalone value is returned when the number is too small to have any prefixes applied to it. This is commonly a special case, so is handled separately.

Prefixed(Prefix, F)

A prefixed value is large enough for prefixes. This holds the prefix, as well as the resulting value.

Implementations

impl<F: Amounts> NumberPrefix<F>

pub fn decimal(amount: F) -> Self

Formats the given floating-point number using decimal prefixes.

This function accepts both f32 and f64 values. If you’re trying to format an integer, you’ll have to cast it first.

Examples

use number_prefix::{Prefix, NumberPrefix};

assert_eq!(NumberPrefix::decimal(1_000_000_000_f32),
           NumberPrefix::Prefixed(Prefix::Giga, 1_f32));

pub fn binary(amount: F) -> Self

Formats the given floating-point number using binary prefixes.

This function accepts both f32 and f64 values. If you’re trying to format an integer, you’ll have to cast it first.

Examples

use number_prefix::{Prefix, NumberPrefix};

assert_eq!(NumberPrefix::binary(1_073_741_824_f64),
           NumberPrefix::Prefixed(Prefix::Gibi, 1_f64));

Trait Implementations

impl<F: Clone> Clone for NumberPrefix<F>

fn clone(&self) -> NumberPrefix<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F: Debug> Debug for NumberPrefix<F>

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

Formats the value using the given formatter.

impl<T: FromStr> FromStr for NumberPrefix<T>

type Err = NumberPrefixParseError

The associated error which can be returned from parsing.

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

Parses a string s to return a value of this type.

impl<F: PartialEq> PartialEq for NumberPrefix<F>

fn eq(&self, other: &NumberPrefix<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<F: Eq> Eq for NumberPrefix<F>

impl<F> StructuralPartialEq for NumberPrefix<F>