Struct sp_runtime::Perbill

pub struct Perbill(_);

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

Parts per Billion

Implementations

impl Perbill

Re-export top-level arithmetic stuff.

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

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

This can be created at compile time.

impl Perbill

Re-export top-level arithmetic stuff.

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

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

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

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

This can be created at compile time.

pub const fn one() -> Perbill

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> Perbill

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

See PerThing::square.

pub fn from_fraction(x: f64) -> Perbill

See PerThing::from_fraction.

pub fn from_rational_approximation<N>(p: N, q: N) -> Perbill 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_approximation.

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.

Trait Implementations

impl Bounded for Perbill

pub fn min_value() -> Perbill

returns the smallest finite number this type can represent

pub fn max_value() -> Perbill

returns the largest finite number this type can represent

impl Clone for Perbill

pub fn clone(&self) -> Perbill

Returns a copy of the value.

pub 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.

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

Returns the compact-encodable type.

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

Decode Self from the compact-decoded type.

impl Copy for Perbill

impl Debug for Perbill

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

Formats the value using the given formatter.

impl Decode for Perbill

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

Attempt to deserialise the value from input.

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

Attempt to skip the encoded value from input.

pub fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl Default for Perbill

pub fn default() -> Perbill

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Div<Perbill> for Perbill

type Output = Perbill

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for Perbill

pub 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.

pub fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

pub 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.

pub fn size_hint(&self) -> usize

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

pub fn encoded_size(&self) -> usize

Calculates the encoded size.

impl EncodeLike<Perbill> for Perbill

impl Eq for Perbill

impl From<Compact<Perbill>> for Perbill

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

Performs the conversion.

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

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

Performs the * operation.

impl Ord for Perbill

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Perbill> for Perbill

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

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

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

This method tests for !=.

impl PartialOrd<Perbill> for Perbill

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

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

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

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

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

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

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

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

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

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

impl PerThing for Perbill

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.

pub const ACCURACY: <Perbill as PerThing>::Inner

The accuracy of this type.

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

Consume self and return the number of parts per thing.

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

Build this type from a number of parts per thing.

pub fn from_fraction(x: f64) -> Perbill

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

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

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

pub fn zero() -> Self

Equivalent to Self::from_parts(0).

pub fn is_zero(&self) -> bool

Return true if this is nothing.

pub fn one() -> Self

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

pub fn is_one(&self) -> bool

Return true if this is one.

pub 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.

pub fn square(self) -> Self

Return the product of multiplication of this value by itself.

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

impl Saturating for Perbill

pub fn saturating_add(self, rhs: Perbill) -> Perbill

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

pub fn saturating_sub(self, rhs: Perbill) -> Perbill

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

pub fn saturating_mul(self, rhs: Perbill) -> Perbill

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

pub fn saturating_pow(self, exp: usize) -> Perbill

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

impl Serialize for Perbill

pub 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 StructuralEq for Perbill

impl StructuralPartialEq for Perbill