Struct bitcoin::util::decimal::Decimal

pub struct Decimal { /* fields omitted */ }

A fixed-point decimal type

Methods

impl Decimal

pub fn new(mantissa: i64, exponent: usize) -> Decimal

Creates a new Decimal

pub fn mantissa(&self) -> i64

Returns the mantissa

pub fn exponent(&self) -> usize

Returns the exponent

pub fn integer_value(&self, exponent: usize) -> i64

Get the decimal's value in an integer type, by multiplying by some power of ten to ensure the returned value is 10 ** exponent types the actual value.

pub fn nonnegative(&self) -> bool

Returns whether or not the number is nonnegative

Trait Implementations

impl PartialOrd<Decimal> for Decimal

fn partial_cmp(&self, other: &Decimal) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Decimal

impl PartialEq<Decimal> for Decimal

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

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

#[must_use]

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

This method tests for !=.

impl Clone for Decimal

fn clone(&self) -> Decimal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Decimal

fn cmp(&self, other: &Decimal) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.

impl Eq for Decimal

impl Display for Decimal

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

Formats the value using the given formatter.

impl Debug for Decimal

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

Formats the value using the given formatter.

impl Sub<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the - operator.

fn sub(self, other: Decimal) -> Decimal

Performs the - operation.

impl Add<Decimal> for Decimal

type Output = Decimal

The resulting type after applying the + operator.

fn add(self, other: Decimal) -> Decimal

Performs the + operation.

impl Neg for Decimal

type Output = Decimal

The resulting type after applying the - operator.

fn neg(self) -> Decimal

Performs the unary - operation.