Struct Ppm

pub struct Ppm(/* private fields */);

A “parts per million” value for proportional fee rates.

Internally stores an i32 in the range [0, 1_000_000]. 1_000_000 ppm = 100%, so 5000 ppm = 0.5%.

Implementations

impl Ppm

pub const MAX: Ppm

The maximum Ppm value (1_000_000 = 100%).

pub const ZERO: Ppm

A Ppm of zero.

pub const fn new(value: i32) -> Ppm

Construct a Ppm from an i32 value.

Panics

Panics at compile time (in const context) or runtime if value is outside the valid range [0, 1_000_000].

pub fn try_from_decimal(rate: Decimal) -> Result<Ppm, Error>

Construct a Ppm from a Decimal value.

The decimal is multiplied by 1_000_000 and rounded to the nearest integer. For example, 0.005 (0.5%) becomes 5000 ppm.

Returns an error if the input is negative or exceeds 1.0.

pub fn try_from_percent(pct: Decimal) -> Result<Ppm, Error>

Construct a Ppm from a Decimal percentage value.

The decimal is multiplied by 10_000 and rounded to the nearest integer. For example, 0.5 (0.5%) becomes 5000 ppm.

Returns an error if the input is negative or exceeds 100.0 (100%).

pub const fn to_i32(self) -> i32

Returns the ppm value as an i32.

pub const fn to_u32(self) -> u32

Returns the ppm value as a u32.

pub const fn to_decimal(self) -> Decimal

Returns the ppm value as a Decimal rate (ppm / 1_000_000).

For example, 5000 ppm becomes 0.005 (0.5%).

pub const fn to_percent(self) -> Decimal

Returns the ppm value as a Decimal percentage (ppm / 10_000).

For example, 5000 ppm becomes 0.5 (0.5%).

Trait Implementations

impl Clone for Ppm

fn clone(&self) -> Ppm

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ppm

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Ppm

fn deserialize<__D>( __deserializer: __D, ) -> Result<Ppm, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Ppm

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

Formats the value using the given formatter.

impl From<u16> for Ppm

fn from(value: u16) -> Ppm

Infallible conversion from u16 (max 65535 < 1_000_000).

impl FromStr for Ppm

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Ppm, <Ppm as FromStr>::Err>

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

impl Hash for Ppm

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Amount> for Ppm

Ppm * Amount => Amount (fee calculation, commutative)

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Amount) -> <Ppm as Mul<Amount>>::Output

Performs the * operation.

impl Mul<Ppm> for Amount

Amount * Ppm => Amount (fee calculation)

type Output = Amount

The resulting type after applying the * operator.

fn mul(self, rhs: Ppm) -> <Amount as Mul<Ppm>>::Output

Performs the * operation.

impl Ord for Ppm

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

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

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

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 TryFrom<Decimal> for Ppm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(rate: Decimal) -> Result<Ppm, <Ppm as TryFrom<Decimal>>::Error>

Performs the conversion.

impl TryFrom<i32> for Ppm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Ppm, <Ppm as TryFrom<i32>>::Error>

Performs the conversion.

impl TryFrom<u32> for Ppm

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Ppm, <Ppm as TryFrom<u32>>::Error>

Performs the conversion.

impl Copy for Ppm

impl Eq for Ppm

impl StructuralPartialEq for Ppm