Struct Wad

pub struct Wad(pub Number);

An 18-decimal fixed-point value (1e18 = 100%), backed by U256.

When the serde feature is enabled, serializes transparently as Number (which serializes to a decimal string for JSON compatibility).

Tuple Fields

0: Number

Implementations

impl Wad

pub const SCALE: u128 = 1_000_000_000_000_000_000u128

Scaling factor (1e18).

pub const ZERO: Wad

pub const ONE: Wad

pub const fn zero() -> Wad

Returns zero.

pub const fn one() -> Wad

Returns one unit (1.0 in WAD scale).

pub fn is_zero(&self) -> bool

pub fn is_one(&self) -> bool

pub fn as_u128_trunc(self) -> u128

Returns the lower 128 bits (truncation) of this WAD value.

pub fn apply_floored(self, amount: Number) -> Number

Applies this WAD-scaled fraction to an unscaled Number, floored.

Trait Implementations

impl BorshDeserialize for Wad

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

where R: Read,

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 BorshSchema for Wad

fn add_definitions_recursively(definitions: &mut BTreeMap<String, Definition>)

Recursively, using DFS, add type definitions required for this type. Type definition partially explains how to serialize/deserialize a type.

fn declaration() -> String

Get the name of the type without brackets.

impl BorshSerialize for Wad

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

where W: Write,

impl Clone for Wad

fn clone(&self) -> Wad

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Wad

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

Formats the value using the given formatter.

impl Default for Wad

fn default() -> Wad

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Wad

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div<Number> for Wad

type Output = Wad

The resulting type after applying the / operator.

fn div(self, rhs: Number) -> Wad

Performs the / operation.

impl Div<u128> for Wad

type Output = Wad

The resulting type after applying the / operator.

fn div(self, rhs: u128) -> Wad

Performs the / operation.

impl From<Number> for Wad

fn from(value: Number) -> Wad

Converts to this type from the input type.

impl From<Wad> for Number

fn from(value: Wad) -> Number

Converts to this type from the input type.

impl From<u128> for Wad

fn from(v: u128) -> Wad

Converts to this type from the input type.

impl JsonSchema for Wad

fn schema_name() -> String

The name of the generated JSON Schema.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

impl Ord for Wad

fn cmp(&self, other: &Wad) -> 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 PartialEq for Wad

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

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

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Wad

impl Eq for Wad

impl StructuralPartialEq for Wad