Struct Percent

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

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

Percent

Implementations

impl Percent

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

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

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

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

This can be created at compile time.

pub const fn one() -> Percent

See PerThing::one

pub fn is_one(&self) -> bool

See PerThing::is_one.

pub const fn zero() -> Percent

See PerThing::zero.

pub fn is_zero(&self) -> bool

See PerThing::is_zero.

pub const fn deconstruct(self) -> u8

See PerThing::deconstruct.

pub fn square(self) -> Percent

See PerThing::square.

pub fn from_float(x: f64) -> Percent

See PerThing::from_float.

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

where N: RationalArg + TryInto<u8> + TryInto<u16>, u8: Into<N>,

👎Deprecated: Use PerThing::from_rational instead

See PerThing::from_rational.

pub fn from_rational<N>(p: N, q: N) -> Percent

where N: RationalArg + TryInto<u8> + TryInto<u16>, u8: Into<N>,

See PerThing::from_rational.

pub fn int_mul(self, b: u8) -> Percent

Integer multiplication with another value, saturating at 1.

pub fn int_div(self, b: Percent) -> u8

Integer division with another value, rounding down.

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

where N: MultiplyArg + UniqueSaturatedInto<u8>, u8: Into<N>,

See PerThing::mul_floor.

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

where N: MultiplyArg + UniqueSaturatedInto<u8>, u8: Into<N>,

See PerThing::mul_ceil.

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

where N: ReciprocalArg + UniqueSaturatedInto<u8>, u8: Into<N>,

See PerThing::saturating_reciprocal_mul.

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

where N: ReciprocalArg + UniqueSaturatedInto<u8>, u8: Into<N>,

See PerThing::saturating_reciprocal_mul_floor.

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

where N: ReciprocalArg + UniqueSaturatedInto<u8>, u8: Into<N>,

See PerThing::saturating_reciprocal_mul_ceil.

pub fn saturating_div(self, rhs: Percent, r: Rounding) -> Percent

Saturating division. Compute self / rhs, saturating at one if rhs < self.

The rounding method must be specified. e.g.:

let pc = |x| Percent::from_percent(x);
assert_eq!(
	pc(2).saturating_div(pc(3), Down),
	pc(66),
);
assert_eq!(
	pc(1).saturating_div(pc(3), NearestPrefUp),
	pc(33),
);
assert_eq!(
	pc(2).saturating_div(pc(3), NearestPrefDown),
	pc(67),
);
assert_eq!(
	pc(1).saturating_div(pc(3), Up),
	pc(34),
);

Trait Implementations

impl Add for Percent

type Output = Percent

The resulting type after applying the + operator.

fn add(self, rhs: Percent) -> <Percent as Add>::Output

Performs the + operation.

impl Bounded for Percent

fn min_value() -> Percent

Returns the smallest finite number this type can represent

fn max_value() -> Percent

Returns the largest finite number this type can represent

impl CheckedAdd for Percent

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

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

impl CheckedMul for Percent

Note

CheckedMul will never fail for PerThings.

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

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

impl CheckedSub for Percent

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

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

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

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

type As = u8

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

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

Returns the compact-encodable type.

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

Decode Self from the compact-decoded type.

impl Debug for Percent

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

Formats the value using the given formatter.

impl Decode for Percent

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

where I: Input,

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

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 Percent

fn default() -> Percent

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<N> Div<N> for Percent

where u8: TryFrom<N>,

type Output = Percent

The resulting type after applying the / operator.

fn div(self, b: N) -> <Percent as Div<N>>::Output

Performs the / operation.

impl Div for Percent

type Output = Percent

The resulting type after applying the / operator.

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

Performs the / operation.

impl Encode for Percent

fn size_hint(&self) -> usize

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

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<__CodecOutputReturn, __CodecUsingEncodedCallback>( &self, f: __CodecUsingEncodedCallback, ) -> __CodecOutputReturn

where __CodecUsingEncodedCallback: FnOnce(&[u8]) -> __CodecOutputReturn,

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

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl From<Compact<Percent>> for Percent

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

Converts to this type from the input type.

impl MaxEncodedLen for Percent

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<N> Mul<N> for Percent

where N: Div<Output = N> + Clone + Mul<Output = N> + UniqueSaturatedInto<u8> + Add<Output = N> + Rem<Output = N> + Unsigned, u8: 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) -> <Percent as Mul<N>>::Output

Performs the * operation.

impl Mul<Weight> for Percent

type Output = Weight

The resulting type after applying the * operator.

fn mul(self, b: Weight) -> Weight

Performs the * operation.

impl Mul for Percent

type Output = Percent

The resulting type after applying the * operator.

fn mul(self, rhs: Percent) -> <Percent as Mul>::Output

Performs the * operation.

impl One for Percent

fn one() -> Percent

Returns the multiplicative identity element of Self, 1.

fn set_one(&mut self)

Sets self to the multiplicative identity element of Self, 1.

fn is_one(&self) -> bool

where Self: PartialEq,

Returns true if self is equal to the multiplicative identity.

impl Ord for Percent

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

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

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

Consume self and return the number of parts per thing.

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

Build this type from a number of parts per thing.

fn from_float(x: f64) -> Percent

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

const ACCURACY: <Percent as PerThing>::Inner = {transmute(0x64): <sp_runtime::Percent as sp_runtime::PerThing>::Inner}

The accuracy of this type.

type Inner = u8

The data type used to build this per-thingy.

type Upper = u16

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_with_rounding<N>( p: N, q: N, r: Rounding, ) -> Result<Percent, ()>

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

Approximate the fraction p/q into a per-thing fraction.

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 less_epsilon(self) -> Self

Return the next lower value to self or self if it is already zero.

fn try_less_epsilon(self) -> Result<Self, Self>

Return the next lower value to self or an error with the same value if self is already zero.

fn plus_epsilon(self) -> Self

Return the next higher value to self or self if it is already one.

fn try_plus_epsilon(self) -> Result<Self, Self>

Return the next higher value to self or an error with the same value if self is already 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: MultiplyArg + UniqueSaturatedInto<Self::Inner>, 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: MultiplyArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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: ReciprocalArg + UniqueSaturatedInto<Self::Inner>, 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<N>(p: N, q: N) -> Self

where N: RationalArg + TryInto<Self::Inner> + TryInto<Self::Upper>, Self::Inner: Into<N>,

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

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

where N: RationalArg + TryInto<Self::Inner> + TryInto<Self::Upper>, Self::Inner: Into<N>,

👎Deprecated: Use from_rational instead

Same as Self::from_rational.

impl Pow<usize> for Percent

type Output = Percent

The result after applying the operator.

fn pow(self, exp: usize) -> <Percent as Pow<usize>>::Output

Returns self to the power rhs.

impl Saturating for Percent

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

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

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

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

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

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

fn saturating_less_one(self) -> Self

where Self: One,

Decrement self by one, saturating at zero.

fn saturating_plus_one(self) -> Self

where Self: One,

Increment self by one, saturating at the numeric bounds instead of overflowing.

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 Percent

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

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

impl SaturatingSub for Percent

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

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

impl Serialize for Percent

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

type Output = Percent

The resulting type after applying the - operator.

fn sub(self, rhs: Percent) -> <Percent as Sub>::Output

Performs the - operation.

impl TypeInfo for Percent

type Identity = Percent

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl Zero for Percent

fn zero() -> Percent

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 Percent

impl DecodeWithMemTracking for Percent

impl EncodeLike for Percent

impl Eq for Percent

impl StructuralPartialEq for Percent