Struct sp_arithmetic::Percent

pub struct Percent(_);

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

Percent

Methods

impl Percent

Implement const functions

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

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

This can be called at compile time.

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

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

This can be created at compile time.

pub fn one() -> Self

Everything.

To avoid having to import PerThing when one needs to be used in test mocks.

Trait Implementations

impl Clone for Percent

fn clone(&self) -> Percent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CompactAs for Percent

type As = u8

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

fn encode_as(&self) -> &u8

Returns the encodable type.

fn decode_from(x: u8) -> Percent

Create Self from the decodable type.

impl Copy for Percent

impl Debug for Percent

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

Formats the value using the given formatter.

impl Decode for Percent

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

Attempt to deserialise the value from input.

impl Default for Percent

fn default() -> Percent

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Percent

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

Deserialize this value from the given Serde deserializer.

impl Div<Percent> for Percent

type Output = Self

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for Percent

fn encode_to<EncOut: Output>(&self, dest: &mut EncOut)

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.

impl EncodeLike<Percent> for Percent

impl Eq for Percent

impl From<Compact<Percent>> for Percent

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

Performs the conversion.

impl<N> Mul<N> for Percent where
    N: Clone + From<u8> + UniqueSaturatedInto<u8> + Rem<N, Output = N> + Div<N, Output = N> + Mul<N, Output = N> + Add<N, Output = N>, 

Overflow-prune multiplication.

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 Ord for Percent

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Percent> for Percent

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

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

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

This method tests for !=.

impl PartialOrd<Percent> for Percent

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

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

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

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

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

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

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

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

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

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

impl PerThing for Percent

type Inner = u8

The data type used to build this per-thingy.

const ACCURACY: Self::Inner

The accuracy of this type.

fn zero() -> Self

Nothing.

fn is_zero(&self) -> bool

true if this is nothing.

fn one() -> Self

Everything.

fn deconstruct(self) -> Self::Inner

Consume self and deconstruct into a raw numeric type.

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

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

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

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

fn square(self) -> Self

Return the product of multiplication of this value by itself.

fn from_fraction(x: f64) -> Self

Converts a fraction into Self.

fn from_rational_approximation<N>(p: N, q: N) -> Self where
    N: Clone + Ord + From<Self::Inner> + TryInto<Self::Inner> + Div<N, Output = N>, 

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

The computation of this approximation is performed in the generic type N. Given M as the data type that can hold the maximum value of this per-thing (e.g. u32 for perbill), this can only work if N == M or N: From<M> + TryInto<M>.

impl Saturating for Percent

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

Saturated addition - if the product can't fit in the type then just use max-value.

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

Saturated subtraction - if the product can't fit in the type then just use max-value.

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

Saturated multiply - if the product can't fit in the type then just use max-value.

impl Serialize for Percent

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Percent

impl StructuralPartialEq for Percent