Struct Permill

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

Re-export top-level arithmetic stuff. A fixed point representation of a number in the range [0, 1].

Parts per Million

Implementations

impl Permill

pub const fn from_parts(parts: u32) -> Permill

From an explicitly defined number of parts per maximum of the type.

pub const fn from_percent(x: u32) -> Permill

Converts a percent into Self. Equal to x / 100.

This can be created at compile time.

pub const fn one() -> Permill

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> Permill

See PerThing::zero.

pub fn is_zero(&self) -> bool

See PerThing::is_zero.

pub const fn deconstruct(self) -> u32

See PerThing::deconstruct.

pub fn square(self) -> Permill

See PerThing::square.

pub fn from_fraction(x: f64) -> Permill

See PerThing::from_fraction.

pub fn from_rational_approximation<N>(p: N, q: N) -> Permill

where N: Clone + Ord + TryInto<u32> + TryInto<u64> + Div<Output = N> + Rem<Output = N> + Add<Output = N> + Unsigned, u32: Into<N>,

See PerThing::from_rational_approximation.

pub fn mul_floor<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<u32> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Unsigned, u32: Into<N>,

See PerThing::mul_floor.

pub fn mul_ceil<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<u32> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Unsigned, u32: Into<N>,

See PerThing::mul_ceil.

pub fn saturating_reciprocal_mul<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<u32> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, u32: Into<N>,

See PerThing::saturating_reciprocal_mul.

pub fn saturating_reciprocal_mul_floor<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<u32> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, u32: Into<N>,

See PerThing::saturating_reciprocal_mul_floor.

pub fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<u32> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, u32: Into<N>,

See PerThing::saturating_reciprocal_mul_ceil.

impl Permill

pub const fn from_perthousand(x: u32) -> Permill

Converts a percent into Self. Equal to x / 1000.

This can be created at compile time.

Trait Implementations

impl Bounded for Permill

fn min_value() -> Permill

Returns the smallest finite number this type can represent

fn max_value() -> Permill

Returns the largest finite number this type can represent

impl Clone for Permill

fn clone(&self) -> Permill

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl CompactAs for Permill

Implementation makes any compact encoding of PerThing::Inner valid, when decoding it will saturate up to PerThing::ACCURACY.

type As = u32

A compact-encodable type that should be used as the encoding.

fn encode_as(&self) -> &<Permill as CompactAs>::As

Returns the compact-encodable type.

fn decode_from(x: <Permill as CompactAs>::As) -> Result<Permill, Error>

Decode Self from the compact-decoded type.

impl Debug for Permill

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

Formats the value using the given formatter.

impl Decode for Permill

fn decode<I>(input: &mut I) -> Result<Permill, Error>

where I: Input,

Attempt to deserialise the value from input.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for Permill

fn default() -> Permill

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Permill

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Div for Permill

type Output = Permill

The resulting type after applying the / operator.

fn div(self, rhs: Permill) -> <Permill as Div>::Output

Performs the / operation.

impl Encode for Permill

fn encode_to<__CodecOutputEdqy>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

where __CodecOutputEdqy: Output + ?Sized,

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<Compact<Permill>> for Permill

fn from(x: Compact<Permill>) -> Permill

Converts to this type from the input type.

impl<N> Mul<N> for Permill

where N: Div<Output = N> + Clone + Mul<Output = N> + UniqueSaturatedInto<u32> + Add<Output = N> + Rem<Output = N> + Unsigned, u32: Into<N>,

Non-overflow multiplication.

This is tailored to be used with a balance type.

type Output = N

The resulting type after applying the * operator.

fn mul(self, b: N) -> <Permill as Mul<N>>::Output

Performs the * operation.

impl Ord for Permill

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

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

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

fn deconstruct(self) -> <Permill as PerThing>::Inner

Consume self and return the number of parts per thing.

fn from_parts(parts: <Permill as PerThing>::Inner) -> Permill

Build this type from a number of parts per thing.

fn from_fraction(x: f64) -> Permill

NOTE: saturate to 0 or 1 if x is beyond [0, 1]

const ACCURACY: <Permill as PerThing>::Inner = {transmute(0x000f4240): <arithmetic::Permill as arithmetic::PerThing>::Inner}

The accuracy of this type.

type Inner = u32

The data type used to build this per-thingy.

type Upper = u64

A data type larger than Self::Inner, used to avoid overflow in some computations. It must be able to compute ACCURACY^2.

fn from_rational_approximation<N>(p: N, q: N) -> Permill

where N: Clone + Ord + TryInto<<Permill as PerThing>::Inner> + TryInto<<Permill as PerThing>::Upper> + Div<Output = N> + Rem<Output = N> + Add<Output = N> + Unsigned + Zero + One, <Permill as PerThing>::Inner: Into<N>,

Approximate the fraction p/q into a per-thing fraction. This will never overflow.

fn zero() -> Self

Equivalent to Self::from_parts(0).

fn is_zero(&self) -> bool

Return true if this is nothing.

fn one() -> Self

Equivalent to Self::from_parts(Self::ACCURACY).

fn is_one(&self) -> bool

Return true if this is one.

fn from_percent(x: Self::Inner) -> Self

Build this type from a percent. Equivalent to Self::from_parts(x * Self::ACCURACY / 100) but more accurate and can cope with potential type overflows.

fn square(self) -> Self

Return the product of multiplication of this value by itself.

fn mul_floor<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Unsigned, Self::Inner: Into<N>,

Multiplication that always rounds down to a whole number. The standard Mul rounds to the nearest whole number.

fn mul_ceil<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Unsigned, Self::Inner: Into<N>,

Multiplication that always rounds the result up to a whole number. The standard Mul rounds to the nearest whole number.

fn saturating_reciprocal_mul<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, Self::Inner: Into<N>,

Saturating multiplication by the reciprocal of self. The result is rounded to the nearest whole number and saturates at the numeric bounds instead of overflowing.

fn saturating_reciprocal_mul_floor<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, Self::Inner: Into<N>,

Saturating multiplication by the reciprocal of self. The result is rounded down to the nearest whole number and saturates at the numeric bounds instead of overflowing.

fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> N

where N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<Output = N> + Div<Output = N> + Mul<Output = N> + Add<Output = N> + Saturating + Unsigned, Self::Inner: Into<N>,

Saturating multiplication by the reciprocal of self. The result is rounded up to the nearest whole number and saturates at the numeric bounds instead of overflowing.

impl Saturating for Permill

fn saturating_add(self, rhs: Permill) -> Permill

Saturating addition. Compute self + rhs, saturating at the numeric bounds instead of overflowing. This operation is lossless if it does not saturate.

fn saturating_sub(self, rhs: Permill) -> Permill

Saturating subtraction. Compute self - rhs, saturating at the numeric bounds instead of overflowing. This operation is lossless if it does not saturate.

fn saturating_mul(self, rhs: Permill) -> Permill

Saturating multiply. Compute self * rhs, saturating at the numeric bounds instead of overflowing. This operation is lossy.

fn saturating_pow(self, exp: usize) -> Permill

Saturating exponentiation. Computes self.pow(exp), saturating at the numeric bounds instead of overflowing. This operation is lossy.

impl Serialize for Permill

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 Permill

impl EncodeLike for Permill

impl Eq for Permill

impl StructuralPartialEq for Permill