Struct friendly::quantity::Quantity

pub struct Quantity<Q: QVal, F: PrefixFamily> { /* fields omitted */ }

A numeric quantity to display.

Quantity is the core type for general display of numeric quantities that may be rescaled with prefixes, may have unit suffixes, etc.

By default, quantities are displayed with 4 significant figures and are auto-scaled. Individual convenience functions may provide different defaults.

Implementations

impl<Q: QVal> Quantity<Q, Decimal>

pub fn decimal(value: Q) -> Self

Create a new auto-scaled decimal quantity.

impl<Q: QVal> Quantity<Q, Binary>

pub fn binary(value: Q) -> Self

Create a new auto-scaled binary quantity.

impl<Q: QVal, F: PrefixFamily> Quantity<Q, F>

pub fn new(value: Q) -> Self

Create a new auto-scaled quantity of arbitrary prefix type.

pub fn scale<F2: PrefixFamily, S: Into<Scale<F2>>>(
    self,
    scale: S
) -> Quantity<Q, F2>

Configure this quantity with a different scale.

The use of Into bounds allows this to rescale with either a fixed scale:

let q = Quantity::decimal(10324);
let q = q.scale(Decimal::KILO);
assert_eq!(q.to_string().as_str(), "10.32 k");

Or auto-scaling:

let q = Quantity::decimal(10324);
let q = q.scale(Decimal::AUTO);
assert_eq!(q.to_string().as_str(), "10.32 k");

pub fn suffix(self, suffix: &'static str) -> Self

Change the unit suffix on this quantity.

pub fn space(self, spc: bool) -> Self

Change whether to include a space before units.

pub fn sig_figs(self, sf: u32) -> Self

Change the significant figures on this quantity.

Trait Implementations

impl<Q: Clone + QVal, F: Clone + PrefixFamily> Clone for Quantity<Q, F>

fn clone(&self) -> Quantity<Q, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Q: Debug + QVal, F: Debug + PrefixFamily> Debug for Quantity<Q, F>

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

Formats the value using the given formatter.

impl<Q: QVal, F: PrefixFamily> Display for Quantity<Q, F>

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

Formats the value using the given formatter.