Struct Multiplier 

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

Multiplier is a quantity specifying a scaling factor of some sort.

It is internally implemented as a u64 fixed point scaled by 1000. It defaults to scaling by 1.0.

Implementations

impl Multiplier

pub const ONE: Self

pub const ZERO: Self

pub const MAX: Self

pub const DECIMALS: usize = 3

pub const fn from_u64_per_1000(x: u64) -> Self

pub fn try_from_f64_strict(x: f64) -> Result<Self, FromF64Error>

Creates a multiplier from f64, requiring max 3 decimals.

Fails if the value has more than 3 decimal places or is out of range.

pub fn try_from_f64_lossy(x: f64) -> Result<Self, FromF64Error>

Creates a multiplier from f64, rounding to 3 decimal places if needed.

Fails only if the value is out of range.

pub const fn as_u64_per_1000(self) -> u64

pub fn as_f64(self) -> f64

Trait Implementations

impl Clone for Multiplier

fn clone(&self) -> Multiplier

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Multiplier

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

Formats the value using the given formatter.

impl Default for Multiplier

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Multiplier

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Multiplier

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

Formats the value using the given formatter.

impl From<Multiplier> for f64

fn from(value: Multiplier) -> Self

Converts to this type from the input type.

impl Ord for Multiplier

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<f64> for Multiplier

type Error = FromF64Error

The type returned in the event of a conversion error.

fn try_from(value: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Multiplier

impl Eq for Multiplier

impl StructuralPartialEq for Multiplier