Struct rink_core::number::NumberParts

pub struct NumberParts {
    pub exact_value: Option<String>,
    pub approx_value: Option<String>,
    pub factor: Option<String>,
    pub divfactor: Option<String>,
    pub raw_unit: Option<Quantity>,
    pub unit: Option<String>,
    pub quantity: Option<String>,
    pub dimensions: Option<String>,
    pub raw_dimensions: Option<Quantity>,
}

Several stringified properties of a number which are useful for displaying it to a user.

Fields

exact_value: Option<String>

Present if the number can be concisely represented exactly. May be decimal, fraction, or scientific notation.

approx_value: Option<String>

Present if the number can’t be exactly concisely represented in decimal or scientific notation.

factor: Option<String>

Numerator factor by which the value is multiplied, if not one.

divfactor: Option<String>

Divisor factor, if not one.

raw_unit: Option<Quantity>

High-level unit decomposition, in format that can be manipulated.

unit: Option<String>

Higher-level unit decomposition, if available.

quantity: Option<String>

The physical quantity associated with the unit, if available.

dimensions: Option<String>

The dimensionality of the unit.

raw_dimensions: Option<Quantity>

Map of base units and their dimensions.

Implementations

impl NumberParts

pub fn format(&self, pat: &str) -> String

A DSL for formatting numbers.

• a: Approximate numerical value, if exists.
• e: Exact numerical value, if exists.
• n: Exact and approximate values.
• u: Unit.
• q: Quantity, if exists.
• w: Quantity in parentheses, if exists.
• d: Dimensionality, if not same as unit.
• D: Dimensionality, always.
• p: Quantity and dimensionality in parentheses.

Display impl is equivalent to n u w.

Whitespace is compacted. Any unrecognized characters are passed through.

pub fn token_format<'a>(&'a self, pattern: &'a str) -> NumberPartsFmt<'a>

A DSL for formatting numbers.

• a: Approximate numerical value, if exists.
• e: Exact numerical value, if exists.
• n: Exact and approximate values.
• u: Unit.
• q: Quantity, if exists.
• w: Quantity in parentheses, if exists.
• d: Dimensionality, if not same as unit.
• D: Dimensionality, always.
• p: Quantity and dimensionality in parentheses.

Display impl is equivalent to n u w.

Whitespace is compacted. Any unrecognized characters are passed through.

Trait Implementations

impl Clone for NumberParts

fn clone(&self) -> NumberParts

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NumberParts

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

Formats the value using the given formatter.

impl Default for NumberParts

fn default() -> NumberParts

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NumberParts

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for NumberParts

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

Formats the value using the given formatter.

impl Serialize for NumberParts

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'a> TokenFmt<'a> for NumberParts

fn to_spans(&'a self) -> Vec<Span<'a>>