Struct sp_arithmetic::per_things::Perbill

pub struct Perbill(_);

A fixed point representation of a number in the range [0, 1].

Parts per Billion

Implementations

impl Perbill

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

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

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

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

This can be created at compile time.

pub const fn one() -> Self

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> Self

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) -> Self

See PerThing::square.

pub fn from_float(x: f64) -> Self

See PerThing::from_float.

pub fn from_rational_approximation<N>(p: N, q: N) -> Self where
    N: Clone + Ord + TryInto<u32> + TryInto<u64> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned,
    u32: Into<N>, 

👎 Deprecated:

Use PerThing::from_rational instead

See PerThing::from_rational.

pub fn from_rational<N>(p: N, q: N) -> Self where
    N: Clone + Ord + TryInto<u32> + TryInto<u64> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned,
    u32: Into<N>, 

See PerThing::from_rational.

pub fn mul_floor<N>(self, b: N) -> N where
    N: Clone + UniqueSaturatedInto<u32> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N> + Saturating + Unsigned,
    u32: Into<N>, 

See PerThing::saturating_reciprocal_mul_ceil.

impl Perbill

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

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

This can be created at compile time.

Trait Implementations

impl Add<Perbill> for Perbill

type Output = Perbill

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Bounded for Perbill

fn min_value() -> Self

returns the smallest finite number this type can represent

fn max_value() -> Self

returns the largest finite number this type can represent

impl CheckedAdd for Perbill

fn checked_add(&self, rhs: &Self) -> Option<Self>

Adds two numbers, checking for overflow. If overflow happens, None is returned.

impl CheckedMul for Perbill

Note

CheckedMul will never fail for PerThings.

fn checked_mul(&self, rhs: &Self) -> Option<Self>

Multiplies two numbers, checking for underflow or overflow. If underflow or overflow happens, None is returned.

impl CheckedSub for Perbill

fn checked_sub(&self, v: &Self) -> Option<Self>

Subtracts two numbers, checking for underflow. If underflow happens, None is returned.

impl Clone for Perbill

fn clone(&self) -> Perbill

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactAs for Perbill

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) -> &Self::As

Returns the compact-encodable type.

fn decode_from(x: Self::As) -> Result<Self, Error>

Decode Self from the compact-decoded type.

impl Debug for Perbill

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

Formats the value using the given formatter.

impl Decode for Perbill

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

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 Perbill

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Perbill

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

Deserialize this value from the given Serde deserializer.

impl<N> Div<N> for Perbill where
    u32: TryFrom<N>, 

type Output = Self

The resulting type after applying the / operator.

fn div(self, b: N) -> Self::Output

Performs the / operation.

impl Div<Perbill> for Perbill

type Output = Self

The resulting type after applying the / operator.

fn div(self, rhs: Self) -> Self::Output

Performs the / operation.

impl Encode for Perbill

fn encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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: FnOnce(&[u8]) -> R>(&self, f: F) -> 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<Perbill>> for Perbill

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

Performs the conversion.

impl<N> Mul<N> for Perbill where
    N: Clone + UniqueSaturatedInto<u32> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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) -> Self::Output

Performs the * operation.

impl Mul<Perbill> for Perbill

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: Self) -> Self::Output

Performs the * operation.

impl Ord for Perbill

fn cmp(&self, other: &Perbill) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Perbill> for Perbill

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Perbill> for Perbill

fn partial_cmp(&self, other: &Perbill) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl PerThing for Perbill

fn deconstruct(self) -> Self::Inner

Consume self and return the number of parts per thing.

fn from_parts(parts: Self::Inner) -> Self

Build this type from a number of parts per thing.

fn from_float(x: f64) -> Self

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

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.

const ACCURACY: Self::Inner

The accuracy of this type.

fn from_rational<N>(p: N, q: N) -> Self where
    N: Clone + Ord + TryInto<Self::Inner> + TryInto<Self::Upper> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned + Zero + One,
    Self::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 left_from_one(self) -> Self

Return the part left when self is saturating-subtracted from Self::one().

fn mul_floor<N>(self, b: N) -> N where
    N: Clone + UniqueSaturatedInto<Self::Inner> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, 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.

fn from_fraction(x: f64) -> Self

👎 Deprecated:

Use from_float instead

Same as Self::from_float.

fn from_rational_approximation<N>(p: N, q: N) -> Self where
    N: Clone + Ord + TryInto<Self::Inner> + TryInto<Self::Upper> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + Unsigned + Zero + One,
    Self::Inner: Into<N>, 

👎 Deprecated:

Use from_rational instead

Same as Self::from_rational.

impl Pow<usize> for Perbill

type Output = Self

The result after applying the operator.

fn pow(self, exp: usize) -> Self::Output

Returns self to the power rhs.

impl Saturating for Perbill

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

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: Self) -> Self

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: Self) -> Self

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

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

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

fn saturating_inc(&mut self) where
    Self: One, 

Increment self by one, saturating.

fn saturating_dec(&mut self) where
    Self: One, 

Decrement self by one, saturating at zero.

fn saturating_accrue(&mut self, amount: Self) where
    Self: One, 

Increment self by some amount, saturating.

fn saturating_reduce(&mut self, amount: Self) where
    Self: One, 

Decrement self by some amount, saturating at zero.

impl SaturatingAdd for Perbill

fn saturating_add(&self, v: &Self) -> Self

Saturating addition. Computes self + other, saturating at the relevant high or low boundary of the type.

impl SaturatingSub for Perbill

fn saturating_sub(&self, v: &Self) -> Self

Saturating subtraction. Computes self - other, saturating at the relevant high or low boundary of the type.

impl Serialize for Perbill

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

Serialize this value into the given Serde serializer.

impl Sub<Perbill> for Perbill

type Output = Perbill

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl TypeInfo for Perbill

type Identity = Self

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Zero for Perbill

fn zero() -> Self

Returns the additive identity element of Self, 0.

fn is_zero(&self) -> bool

Returns true if self is equal to the additive identity.

fn set_zero(&mut self)

Sets self to the additive identity element of Self, 0.

impl Copy for Perbill

impl EncodeLike<Perbill> for Perbill

impl Eq for Perbill

impl StructuralEq for Perbill

impl StructuralPartialEq for Perbill