Struct CompactDecimal

pub struct CompactDecimal { /* private fields */ }

A struct containing a Decimal significand together with an exponent, representing a number written in compact notation (such as 1.2M). This represents a source number, as defined in UTS #35. The value exponent=0 represents a number in non-compact notation (such as 1 200 000).

This is distinct from crate::ScientificDecimal because it does not represent leading 0s nor a sign in the exponent, and behaves differently in pluralization.

Implementations

impl CompactDecimal

pub fn from_significand_and_exponent(significand: Decimal, exponent: u8) -> Self

Constructs a CompactDecimal from its significand and exponent.

pub fn significand(&self) -> &Decimal

Returns a reference to the significand of self.

assert_eq!(
    CompactDecimal::from_str("+1.20c6").unwrap().significand(),
    &Decimal::from_str("+1.20").unwrap()
);

pub fn into_significand(self) -> Decimal

Returns the significand of self.

assert_eq!(
    CompactDecimal::from_str("+1.20c6")
        .unwrap()
        .into_significand(),
    Decimal::from_str("+1.20").unwrap()
);

pub fn exponent(&self) -> u8

Returns the exponent of self.

assert_eq!(CompactDecimal::from_str("+1.20c6").unwrap().exponent(), 6);
assert_eq!(CompactDecimal::from_str("1729").unwrap().exponent(), 0);

impl CompactDecimal

pub fn to_string(&self) -> String

Converts the given value to a String.

Under the hood, this uses an efficient [Writeable] implementation. However, in order to avoid allocating a string, it is more efficient to use [Writeable] directly.

impl CompactDecimal

pub fn try_from_str(s: &str) -> Result<Self, ParseError>

Parses a CompactDecimal.

Trait Implementations

impl Clone for CompactDecimal

fn clone(&self) -> CompactDecimal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CompactDecimal

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

Formats the value using the given formatter.

impl Display for CompactDecimal

This trait is implemented for compatibility with fmt!. To create a string, [Writeable::write_to_string] is usually more efficient.

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

Formats the value using the given formatter.

impl FromStr for CompactDecimal

type Err = ParseError

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 PartialEq for CompactDecimal

fn eq(&self, other: &CompactDecimal) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl Writeable for CompactDecimal

Render the CompactDecimal in sampleValue syntax. The letter c is used, rather than the deprecated e.

Examples

assert_writeable_eq!(
    CompactDecimal::from_str("+1.20c6").unwrap(),
    "+1.20c6"
);
assert_writeable_eq!(CompactDecimal::from_str("+1729").unwrap(), "+1729");

fn write_to<W: Write + ?Sized>(&self, sink: &mut W) -> Result

Writes a string to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to_parts, and discards any Part annotations.

fn writeable_length_hint(&self) -> LengthHint

Returns a hint for the number of UTF-8 bytes that will be written to the sink.

fn write_to_parts<S>(&self, sink: &mut S) -> Result<(), Error>

where S: PartsWrite + ?Sized,

Write bytes and Part annotations to the given sink. Errors from the sink are bubbled up. The default implementation delegates to write_to, and doesn’t produce any Part annotations.

fn write_to_string(&self) -> Cow<'_, str>

Creates a new String with the data from this Writeable. Like ToString, but smaller and faster.

impl StructuralPartialEq for CompactDecimal