Struct fixed_decimal::decimal::FixedDecimal

pub struct FixedDecimal { /* fields omitted */ }

A struct containing decimal digits with efficient iteration and manipulation by magnitude (power of 10). Supports a mantissa of non-zero digits and a number of leading and trailing zeros, used for formatting and plural selection.

You can create a FixedDecimal from a standard integer type. To represent fraction digits, call .multiply_pow10() after creating your FixedDecimal.

Examples

use fixed_decimal::FixedDecimal;

let mut dec = FixedDecimal::from(250);
assert_eq!("250", dec.to_string());

dec.multiply_pow10(-2);
assert_eq!("2.50", dec.to_string());

Implementations

impl FixedDecimal

pub fn digit_at(&self, magnitude: i16) -> u8

Gets the digit at the specified order of magnitude. Returns 0 if the magnitude is out of range of the currently visible digits.

Examples

use fixed_decimal::FixedDecimal;

let dec = FixedDecimal::from(945);
assert_eq!(0, dec.digit_at(-1));
assert_eq!(5, dec.digit_at(0));
assert_eq!(4, dec.digit_at(1));
assert_eq!(9, dec.digit_at(2));
assert_eq!(0, dec.digit_at(3));

pub const fn magnitude_range(&self) -> RangeInclusive<i16>

Gets the visible range of digit magnitudes, in ascending order of magnitude. Call .rev() on the return value to get the range in descending order. Magnitude 0 is always included, even if the number has leading or trailing zeros.

Examples

use fixed_decimal::FixedDecimal;

let mut dec = FixedDecimal::from(120);
assert_eq!(0..=2, dec.magnitude_range());

pub fn multiply_pow10(&mut self, delta: i16) -> Result<(), Error>

Shift the digits by a power of 10, modifying self.

Leading or trailing zeros may be added to keep the digit at magnitude 0 (the last digit before the decimal separator) visible.

Can fail if the change in magnitude pushes the digits out of bounds; the magnitudes of all digits should fit in an i16.

Examples

use fixed_decimal::FixedDecimal;

let mut dec = FixedDecimal::from(42);
assert_eq!("42", dec.to_string());

dec.multiply_pow10(3).expect("Bounds are small");
assert_eq!("42000", dec.to_string());

pub fn multiplied_pow10(self, delta: i16) -> Result<Self, Error>

Shift the digits by a power of 10, consuming self and returning a new object if successful.

Leading or trailing zeros may be added to keep the digit at magnitude 0 (the last digit before the decimal separator) visible.

Can fail if the change in magnitude pushes the digits out of bounds; the magnitudes of all digits should fit in an i16.

Examples

use fixed_decimal::FixedDecimal;

let dec = FixedDecimal::from(42).multiplied_pow10(3).expect("Bounds are small");
assert_eq!("42000", dec.to_string());

pub fn negate(&mut self)

Change the value from negative to positive or from positive to negative, modifying self.

Examples

use fixed_decimal::FixedDecimal;

let mut dec = FixedDecimal::from(42);
assert_eq!("42", dec.to_string());

dec.negate();
assert_eq!("-42", dec.to_string());

dec.negate();
assert_eq!("42", dec.to_string());

pub fn negated(self) -> Self

Change the value from negative to positive or from positive to negative, consuming self and returning a new object.

Examples

use fixed_decimal::FixedDecimal;

assert_eq!(FixedDecimal::from(-42), FixedDecimal::from(42).negated());

pub fn signum(&self) -> Signum

Returns the Signum of this FixedDecimal.

Examples

use fixed_decimal::FixedDecimal;
use fixed_decimal::Signum;

assert_eq!(Signum::AboveZero, FixedDecimal::from(42).signum());
assert_eq!(Signum::PositiveZero, FixedDecimal::from(0).signum());
assert_eq!(Signum::NegativeZero, FixedDecimal::from(0).negated().signum());
assert_eq!(Signum::BelowZero, FixedDecimal::from(-42).signum());

Trait Implementations

impl Clone for FixedDecimal

fn clone(&self) -> FixedDecimal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FixedDecimal

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

Formats the value using the given formatter.

impl Default for FixedDecimal

fn default() -> Self

Returns a FixedDecimal representing zero.

impl Display for FixedDecimal

Renders the FixedDecimal according to the syntax documented in FixedDecimal::write_to.

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

Formats the value using the given formatter.

impl From<i128> for FixedDecimal

fn from(value: i128) -> Self

Performs the conversion.

impl From<i16> for FixedDecimal

fn from(value: i16) -> Self

Performs the conversion.

impl From<i32> for FixedDecimal

fn from(value: i32) -> Self

Performs the conversion.

impl From<i64> for FixedDecimal

fn from(value: i64) -> Self

Performs the conversion.

impl From<i8> for FixedDecimal

fn from(value: i8) -> Self

Performs the conversion.

impl From<isize> for FixedDecimal

fn from(value: isize) -> Self

Performs the conversion.

impl From<u128> for FixedDecimal

fn from(value: u128) -> Self

Performs the conversion.

impl From<u16> for FixedDecimal

fn from(value: u16) -> Self

Performs the conversion.

impl From<u32> for FixedDecimal

fn from(value: u32) -> Self

Performs the conversion.

impl From<u64> for FixedDecimal

fn from(value: u64) -> Self

Performs the conversion.

impl From<u8> for FixedDecimal

fn from(value: u8) -> Self

Performs the conversion.

impl From<usize> for FixedDecimal

fn from(value: usize) -> Self

Performs the conversion.

impl FromStr for FixedDecimal

type Err = Error

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<FixedDecimal> for FixedDecimal

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

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

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

This method tests for !=.

impl StructuralPartialEq for FixedDecimal

impl Writeable for FixedDecimal

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

Render the FixedDecimal as a string of ASCII digits with a possible decimal point.

Examples

use fixed_decimal::FixedDecimal;
use writeable::Writeable;

let dec = FixedDecimal::from(42);
let mut result = String::with_capacity(dec.write_len().capacity());
dec.write_to(&mut result).expect("write_to(String) should not fail");
assert_eq!("42", result);

fn write_len(&self) -> LengthHint

The number of bytes that will be written by FixedDecimal::write_to. Use this function to pre-allocate capacity in the destination buffer.

Examples

use fixed_decimal::FixedDecimal;
use writeable::Writeable;
use writeable::LengthHint;

let dec = FixedDecimal::from(-5000).multiplied_pow10(-2).expect("Bounds are small");
let result = dec.writeable_to_string();
assert_eq!(LengthHint::Exact(6), dec.write_len());

pub fn writeable_to_string(&self) -> String

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