Struct Decimal

pub struct Decimal {
    pub value: u32,
    pub decimal_multiplier: u8,
}

Decimal type for storing prices.

Fields

value: u32

Value.

decimal_multiplier: u8

Decimal multiplier.

Implementations

impl Decimal

pub const MAX_DECIMALS: u8 = 20u8

The Maximum Decimals. Should satisfy MAX_DECIMALS <= 30.

pub const MAX_DECIMAL_MULTIPLIER: u8 = 20u8

The Maximum Decimal Multiplier, which should satisfy u32::MAX * 10^{MAX_DECIMAL_MULTIPLIER} <= u128::MAX.

pub fn to_unit_price(&self) -> u128

Returns the price of one unit (with decimals to be MAX_DECIMALS).

pub fn try_from_price( price: u128, decimals: u8, token_decimals: u8, precision: u8, ) -> Result<Self, DecimalError>

Create price decimal from the given price with decimals, where token_decimals is the expected unit and with expected precision.

pub const fn decimal_multiplier_from_precision( decimals: u8, precision: u8, ) -> u8

Calculate the decimal multiplier with the desired precision.

Warning

One should check that decimals + precision is not greater than MAX_DECIMALS, otherwise the result might be incorrect due to underflow.

pub fn maximum(&self) -> Self

Returns the max representable decimal with the same decimal multiplier.

Trait Implementations

impl BorshDeserialize for Decimal

where u32: BorshDeserialize, u8: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for Decimal

where u32: BorshSerialize, u8: BorshSerialize,

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8>, Error>

Serialize this instance into a vector of bytes.

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 Debug for Decimal

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

Formats the value using the given formatter.

impl PartialEq for Decimal

fn eq(&self, other: &Decimal) -> 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 Space for Decimal

const INIT_SPACE: usize = 5usize

impl Copy for Decimal

impl Eq for Decimal

impl StructuralPartialEq for Decimal