Struct fixed_decimal::FixedDecimal

source ·

pub struct FixedDecimal { /* private fields */ }

Expand description

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, as well as an optional sign; used for formatting and plural selection.

Data Types

The following types can be converted to a FixedDecimal:

Integers, signed and unsigned
Strings representing an arbitrary-precision decimal

To create a FixedDecimal with fraction digits, either create it from an integer and then call FixedDecimal::multiplied_pow10, or create it from a string.

Floating point numbers will be supported pending a resolution to #166. In the mean time, a third-party float-to-string library may be used.

Magnitude and Position

Each digit in a FixedDecimal is indexed by a magnitude, or the digit’s power of 10. Illustration for the number “12.34”:

Magnitude	Digit	Description
1	1	Tens place
0	2	Ones place
-1	3	Tenths place
-2	4	Hundredths place

Some functions deal with a position for the purpose of padding, truncating, or rounding a number. In these cases, the position is the index on the right side of the digit of the corresponding magnitude. Illustration:

Position:   2   0  -2
Number:     |1|2.3|4|
Position:     1  -1

Expected output of various operations, all with input “12.34”:

Operation	Position	Expected Result
Truncate Left	1	10
Truncate Right	-1	12.3
Pad Left	4	0012.34
Pad Right	-4	12.3400

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());

Struct fixed_decimal::FixedDecimal

Implementations§

impl FixedDecimal

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

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

pub fn nonzero_magnitude_start(&self) -> i16

pub fn nonzero_magnitude_end(&self) -> i16

pub fn is_zero(&self) -> bool

pub fn multiply_pow10(&mut self, delta: i16)

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

pub fn sign(&self) -> Sign

pub fn set_sign(&mut self, sign: Sign)

pub fn with_sign(self, sign: Sign) -> Self

pub fn apply_sign_display(&mut self, sign_display: SignDisplay)

pub fn with_sign_display(self, sign_display: SignDisplay) -> Self

pub fn trimmed_start(self) -> Self

pub fn trim_start(&mut self)

pub fn trimmed_end(self) -> Self

pub fn trim_end(&mut self)

pub fn padded_start(self, position: i16) -> Self

pub fn pad_start(&mut self, position: i16)

pub fn padded_end(self, position: i16) -> Self

pub fn pad_end(&mut self, position: i16)

pub fn with_max_position(self, position: i16) -> Self

pub fn set_max_position(&mut self, position: i16)

pub fn trunced(self, position: i16) -> Self

pub fn trunc(&mut self, position: i16)

pub fn trunced_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn trunc_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_trunc(&mut self, position: i16)

pub fn half_trunc_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_trunced(self, position: i16) -> Self

pub fn half_trunced_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn expand(&mut self, position: i16)

pub fn expand_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn expanded(self, position: i16) -> Self

pub fn expanded_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn half_expand(&mut self, position: i16)

pub fn half_expand_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_expanded(self, position: i16) -> Self

pub fn half_expanded_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn ceil(&mut self, position: i16)

pub fn ceil_to_increment(&mut self, position: i16, increment: RoundingIncrement)

pub fn ceiled(self, position: i16) -> Self

pub fn ceiled_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn half_ceil(&mut self, position: i16)

pub fn half_ceil_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_ceiled(self, position: i16) -> Self

pub fn half_ceiled_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn floor(&mut self, position: i16)

pub fn floor_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn floored(self, position: i16) -> Self

pub fn floored_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn half_floor(&mut self, position: i16)

pub fn half_floor_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_floored(self, position: i16) -> Self

pub fn half_floored_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn half_even(&mut self, position: i16)

pub fn half_even_to_increment( &mut self, position: i16, increment: RoundingIncrement )

pub fn half_evened(self, position: i16) -> Self

pub fn half_evened_to_increment( self, position: i16, increment: RoundingIncrement ) -> Self

pub fn concatenated_end(self, other: FixedDecimal) -> Result<Self, FixedDecimal>

pub fn concatenate_end( &mut self, other: FixedDecimal ) -> Result<(), FixedDecimal>

impl FixedDecimal

pub fn try_from_f64( float: f64, precision: FloatPrecision ) -> Result<Self, Error>

Trait Implementations§

impl Clone for FixedDecimal

fn clone(&self) -> FixedDecimal

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

impl Debug for FixedDecimal

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

impl Default for FixedDecimal

fn default() -> Self

impl Display for FixedDecimal

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

impl From<FixedInteger> for FixedDecimal

fn from(value: FixedInteger) -> Self

impl From<i128> for FixedDecimal

fn from(value: i128) -> Self

impl From<i16> for FixedDecimal