Struct Fixed

pub struct Fixed<T, const DECIMALS: u8>(/* private fields */);

Fixed-point decimal type.

Implementations

impl<T, const DECIMALS: u8> Fixed<T, DECIMALS>

pub fn get(&self) -> &T

Get the internal integer representation.

pub fn from_inner(inner: T) -> Self

Create a new decimal from the inner representation.

pub fn into_inner(self) -> T

Get the inner value.

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> Fixed<T, DECIMALS>

pub const ONE: Fixed<T, DECIMALS>

The unit value.

pub const DECIMALS: u8 = DECIMALS

The decimals.

pub fn checked_pow(&self, exponent: &Self) -> Option<Self>

Checked pow.

Trait Implementations

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> Add for Fixed<T, DECIMALS>

type Output = Fixed<T, DECIMALS>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> CheckedAdd for Fixed<T, DECIMALS>

fn checked_add(&self, v: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> CheckedMul for Fixed<T, DECIMALS>

fn checked_mul(&self, v: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl<T: Clone, const DECIMALS: u8> Clone for Fixed<T, DECIMALS>

fn clone(&self) -> Fixed<T, DECIMALS>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, const DECIMALS: u8> Debug for Fixed<T, DECIMALS>

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

Formats the value using the given formatter.

impl<T: Default, const DECIMALS: u8> Default for Fixed<T, DECIMALS>

fn default() -> Fixed<T, DECIMALS>

Returns the “default value” for a type.

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> Mul for Fixed<T, DECIMALS>

type Output = Fixed<T, DECIMALS>

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> One for Fixed<T, DECIMALS>

fn one() -> Self

Returns the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

impl<T: Ord, const DECIMALS: u8> Ord for Fixed<T, DECIMALS>

fn cmp(&self, other: &Fixed<T, DECIMALS>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq, const DECIMALS: u8> PartialEq for Fixed<T, DECIMALS>

fn eq(&self, other: &Fixed<T, DECIMALS>) -> 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<T: PartialOrd, const DECIMALS: u8> PartialOrd for Fixed<T, DECIMALS>

fn partial_cmp(&self, other: &Fixed<T, DECIMALS>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<T: FixedPointOps<DECIMALS>, const DECIMALS: u8> Zero for Fixed<T, DECIMALS>

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl<T: Copy, const DECIMALS: u8> Copy for Fixed<T, DECIMALS>

impl<T: Eq, const DECIMALS: u8> Eq for Fixed<T, DECIMALS>

impl<T, const DECIMALS: u8> StructuralPartialEq for Fixed<T, DECIMALS>