Struct fixed_decimal::CompactDecimal

pub struct CompactDecimal {
    significand: FixedDecimal,
    exponent: u8,
}

A struct containing a FixedDecimal 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.

Fields

significand: FixedDecimal

exponent: u8

Implementations

impl CompactDecimal

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

Constructs a CompactDecimal from its significand and exponent.

pub fn significand(&self) -> &FixedDecimal

Returns a reference to the significand of self.

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

pub fn into_significand(self) -> FixedDecimal

Returns the significand of self.

assert_eq!(
    CompactDecimal::from_str("+1.20c6")
        .unwrap()
        .into_significand(),
    FixedDecimal::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);

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 = FixedDecimalError

The associated error which can be returned from parsing.

fn from_str(input_str: &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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&[u8]> for CompactDecimal

The deprecated letter e is not accepted as a synonym for c.

type Error = FixedDecimalError

The type returned in the event of a conversion error.

fn try_from(input_str: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

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.

fn writeable_cmp_bytes(&self, other: &[u8]) -> Ordering

Compares the contents of this Writeable to the given bytes without allocating a String to hold the Writeable contents.

impl StructuralPartialEq for CompactDecimal