Enum number_prefix::NumberPrefix

source · [−]

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

Expand description

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. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

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

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

Formats the value using the given formatter. Read more

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. Read more

impl<F: PartialEq> PartialEq<NumberPrefix<F>> 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 ==. Read more

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

This method tests for !=.

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

impl<F> StructuralEq for NumberPrefix<F>

impl<F> StructuralPartialEq for NumberPrefix<F>

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,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

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

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.