Struct Dec 

pub struct Dec { /* private fields */ }

An exact decimal, units / 10^scale, for every amount the venue prices in. The venue sends and takes these as strings, and a float between the two would change the figure that gets signed.

Implementations

impl Dec

pub const ZERO: Dec

pub const ONE: Dec

pub const fn new(units: i128, scale: u32) -> Option<Dec>

units / 10^scale. A scale past MAX_SCALE is refused.

pub const fn lit<const SCALE: u32>(units: i128) -> Dec

units / 10^SCALE for a figure written into the code: Dec::lit::<2>(475) is 4.75. The scale is checked when the program is built, so a constant needs no fallback; one past MAX_SCALE does not compile.

const TOO_FINE: df_hyperliquid_core::utils::Dec = df_hyperliquid_core::utils::Dec::lit::<19>(1);

pub const fn from_int(whole: i64) -> Dec

pub fn parse(text: &str) -> Result<Dec, BadDec>

Reads what the venue writes: an optional sign, digits, and at most one point. No exponent, since the venue never sends one.

pub const fn is_zero(self) -> bool

pub const fn is_negative(self) -> bool

pub const fn is_positive(self) -> bool

pub fn is_integer(self) -> bool

pub fn places(self) -> u32

How many places behind the point the value needs.

pub const fn abs(self) -> Dec

pub const fn negate(self) -> Dec

pub fn units_at(self, places: u32, round: Round) -> Option<i128>

The value as a count of 10^-places, rounded as asked. An integer amount on a chain (USDC in millionths, say) comes out of here.

pub fn round(self, places: u32, round: Round) -> Dec

Kept to at most places behind the point.

pub fn sig_places(self, figures: u32) -> u32

The places figures significant digits reach for this value: 2 for 123.456 at five figures, 6 for 0.01234567; 0 when they end in the whole part (123456.7).

pub fn round_sig(self, figures: u32, round: Round) -> Dec

Kept to at most figures significant digits. Digits dropped before the point become zeros, so 123456.7 to five figures is 123450.

pub fn checked_add(self, other: Dec) -> Option<Dec>

pub fn checked_sub(self, other: Dec) -> Option<Dec>

pub fn checked_sum(figures: impl IntoIterator<Item = Dec>) -> Option<Dec>

Every figure added exactly, in order; zero for none. None once a running total passes what a Dec holds.

pub fn checked_mul(self, other: Dec) -> Option<Dec>

Exact while the product fits eighteen places; past that, the nearest.

pub fn checked_div(self, other: Dec, places: u32, round: Round) -> Option<Dec>

self / other kept to places behind the point.

pub fn to_wire(self) -> String

The canonical spelling: no trailing zeros, no exponent, 0 for zero. This is the string that is hashed, so it must match the venue’s clients.

Trait Implementations

impl Clone for Dec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Dec

impl Debug for Dec

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

Formats the value using the given formatter.

impl Default for Dec

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Dec

From the venue’s decimal strings, or a JSON integer. A JSON fraction is refused: it has already been through a float.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Dec

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

Formats the value using the given formatter.

impl Eq for Dec

impl FromStr for Dec

type Err = BadDec

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for Dec

fn cmp(&self, other: &Dec) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Dec

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Dec

fn partial_cmp(&self, other: &Dec) -> 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 Serialize for Dec

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.