[−][src]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.

Methods

impl<F: Amounts> NumberPrefix<F>[src]

pub fn decimal(amount: F) -> Self[src]

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[src]

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>[src]

impl<F: Debug> Debug for NumberPrefix<F>[src]

impl<F: Eq> Eq for NumberPrefix<F>[src]

impl<T: FromStr> FromStr for NumberPrefix<T>[src]

type Err = NumberPrefixParseError

The associated error which can be returned from parsing.

impl<F: PartialEq> PartialEq<NumberPrefix<F>> for NumberPrefix<F>[src]

impl<F> StructuralEq for NumberPrefix<F>[src]

impl<F> StructuralPartialEq for NumberPrefix<F>[src]

Auto Trait Implementations

impl<F> RefUnwindSafe for NumberPrefix<F> where
    F: RefUnwindSafe, 

impl<F> Send for NumberPrefix<F> where
    F: Send, 

impl<F> Sync for NumberPrefix<F> where
    F: Sync, 

impl<F> Unpin for NumberPrefix<F> where
    F: Unpin, 

impl<F> UnwindSafe for NumberPrefix<F> where
    F: UnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToOwned for T where
    T: Clone, [src]

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.