# Struct sp_arithmetic::per_things::Perbill

``pub struct Perbill(_);``
Expand description

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

Parts per Billion

## Implementations§

source§

### impl Perbill

source

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

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

source

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

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

This can be created at compile time.

source

source

source

source

source

source

source

source

#### pub fn from_rational_approximation<N>(p: N, q: N) -> Selfwhere N: RationalArg + TryInto<u32> + TryInto<u64>, u32: Into<N>,

👎Deprecated: Use `PerThing::from_rational` instead
source

source

#### pub fn int_mul(self, b: u32) -> Self

Integer multiplication with another value, saturating at 1.

source

#### pub fn int_div(self, b: Self) -> u32

Integer division with another value, rounding down.

source

source

source

source

source

source

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

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),
);``````
source§

### impl Perbill

source

#### 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§

source§

§

#### type Output = Perbill

The resulting type after applying the `+` operator.
source§

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

Performs the `+` operation. Read more
source§

### impl Bounded for Perbill

source§

#### fn min_value() -> Self

Returns the smallest finite number this type can represent
source§

#### fn max_value() -> Self

Returns the largest finite number this type can represent
source§

source§

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

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

### impl CheckedMul for Perbill

#### Note

CheckedMul will never fail for PerThings.

source§

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

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

### impl CheckedSub for Perbill

source§

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

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

### impl Clone for Perbill

source§

#### fn clone(&self) -> Perbill

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from `source`. Read more
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.
source§

#### fn encode_as(&self) -> &Self::As

Returns the compact-encodable type.
source§

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

Decode `Self` from the compact-decoded type.
source§

### impl Debug for Perbill

source§

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

Formats the value using the given formatter. Read more
source§

### impl Decode for Perbill

source§

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

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. Read more
§

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

Attempt to skip the encoded value from input. Read more
§

#### fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type. Read more
source§

### impl Default for Perbill

source§

#### fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

### impl<N> Div<N> for Perbillwhere u32: TryFrom<N>,

§

#### type Output = Perbill

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl Div<Perbill> for Perbill

§

#### type Output = Perbill

The resulting type after applying the `/` operator.
source§

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

Performs the `/` operation. Read more
source§

### impl Encode for Perbill

source§

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

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

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

Convert self to an owned vector.
source§

#### 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. Read more
§

#### fn encoded_size(&self) -> usize

Calculates the encoded size. Read more
source§

### impl From<Compact<Perbill>> for Perbill

source§

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

Converts to this type from the input type.
source§

### impl MaxEncodedLen for Perbill

source§

#### fn max_encoded_len() -> usize

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

### impl<N> Mul<N> for Perbillwhere 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.
source§

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

Performs the `*` operation. Read more
source§

### impl Mul<Perbill> for Perbill

§

#### type Output = Perbill

The resulting type after applying the `*` operator.
source§

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

Performs the `*` operation. Read more
source§

### impl One for Perbill

source§

#### fn one() -> Self

Returns the multiplicative identity element of `Self`, `1`. Read more
source§

#### fn set_one(&mut self)

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

#### fn is_one(&self) -> boolwhere Self: PartialEq<Self>,

Returns `true` if `self` is equal to the multiplicative identity. Read more
source§

### impl Ord for Perbill

source§

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

This method returns an `Ordering` between `self` and `other`. Read more
1.21.0 · source§

#### fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · source§

#### fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · source§

#### fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval. Read more
source§

### impl PartialEq<Perbill> for Perbill

source§

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

This method tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · source§

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

This method tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

### impl PartialOrd<Perbill> for Perbill

source§

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

This method returns an ordering between `self` and `other` values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more
1.0.0 · source§

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

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more
1.0.0 · source§

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

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

### impl PerThing for Perbill

source§

#### fn deconstruct(self) -> Self::Inner

Consume self and return the number of parts per thing.

source§

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

Build this type from a number of parts per thing.

source§

#### 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`.
source§

#### const ACCURACY: Self::Inner = {transmute(0x3b9aca00): <per_things::Perbill as per_things::PerThing>::Inner}

The accuracy of this type.
source§

#### fn from_rational_with_rounding<N>(p: N, q: N, r: Rounding) -> Result<Self, ()>where N: Clone + Ord + TryInto<Self::Inner> + TryInto<Self::Upper> + Div<N, Output = N> + Rem<N, Output = N> + Add<N, Output = N> + AddAssign<N> + Unsigned + Zero + One + MultiplyRational, Self::Inner: Into<N>,

Approximate the fraction `p/q` into a per-thing fraction. Read more
source§

#### fn zero() -> Self

Equivalent to `Self::from_parts(0)`.
source§

#### fn is_zero(&self) -> bool

Return `true` if this is nothing.
source§

#### fn one() -> Self

Equivalent to `Self::from_parts(Self::ACCURACY)`.
source§

#### fn is_one(&self) -> bool

Return `true` if this is one.
source§

#### fn less_epsilon(self) -> Self

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

#### 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.
source§

#### fn plus_epsilon(self) -> Self

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

#### 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.
source§

#### 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.
source§

#### fn square(self) -> Self

Return the product of multiplication of this value by itself.
source§

#### fn left_from_one(self) -> Self

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

#### fn mul_floor<N>(self, b: N) -> Nwhere 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. Read more
source§

#### fn mul_ceil<N>(self, b: N) -> Nwhere 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. Read more
source§

#### fn saturating_reciprocal_mul<N>(self, b: N) -> Nwhere 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. Read more
source§

#### fn saturating_reciprocal_mul_floor<N>(self, b: N) -> Nwhere 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. Read more
source§

#### fn saturating_reciprocal_mul_ceil<N>(self, b: N) -> Nwhere 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. Read more
source§

#### fn from_fraction(x: f64) -> Self

Same as `Self::from_float`.
source§

#### fn from_rational<N>(p: N, q: N) -> Selfwhere 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. Read more
source§

#### fn from_rational_approximation<N>(p: N, q: N) -> Selfwhere N: RationalArg + TryInto<Self::Inner> + TryInto<Self::Upper>, Self::Inner: Into<N>,

Same as `Self::from_rational`.
source§

### impl Pow<usize> for Perbill

§

#### type Output = Perbill

The result after applying the operator.
source§

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

Returns `self` to the power `rhs`. Read more
source§

### impl Saturating for Perbill

source§

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

source§

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

source§

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

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

source§

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

source§

#### fn saturating_less_one(self) -> Selfwhere Self: One,

Decrement self by one, saturating at zero.
source§

#### fn saturating_plus_one(self) -> Selfwhere Self: One,

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

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

Increment self by one, saturating.
source§

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

Decrement self by one, saturating at zero.
source§

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

Increment self by some `amount`, saturating.
source§

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

Decrement self by some `amount`, saturating at zero.
source§

source§

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

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

### impl SaturatingSub for Perbill

source§

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

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

### impl Serialize for Perbill

source§

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

Serialize this value into the given Serde serializer. Read more
source§

### impl Sub<Perbill> for Perbill

§

#### type Output = Perbill

The resulting type after applying the `-` operator.
source§

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

Performs the `-` operation. Read more
source§

### impl TypeInfo for Perbill

§

#### type Identity = Perbill

The type identifying for which type info is provided. Read more
source§

#### fn type_info() -> Type

Returns the static type identifier for `Self`.
source§

### impl Zero for Perbill

source§

#### fn zero() -> Self

Returns the additive identity element of `Self`, `0`. Read more
source§

#### fn is_zero(&self) -> bool

Returns `true` if `self` is equal to the additive identity.
source§

#### fn set_zero(&mut self)

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

source§

source§

source§

source§

§

§

§

§

§

## Blanket Implementations§

source§

### impl<T> Any for Twhere T: 'static + ?Sized,

source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
source§

### impl<T> Borrow<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

### impl<T> BorrowMut<T> for Twhere T: ?Sized,

const: unstable · source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

### impl<T> DecodeAll for Twhere T: Decode,

§

#### fn decode_all(input: &mut &[u8]) -> Result<T, Error>

Decode `Self` and consume all of the given input data. Read more
§

### impl<T> DecodeLimit for Twhere T: Decode,

§

#### fn decode_all_with_depth_limit( limit: u32, input: &mut &[u8] ) -> Result<T, Error>

Decode `Self` and consume all of the given input data. Read more
§

#### fn decode_with_depth_limit<I>(limit: u32, input: &mut I) -> Result<T, Error>where I: Input,

Decode `Self` with the given maximum recursion depth and advance `input` by the number of bytes consumed. Read more
source§

### impl<T> From<T> for T

const: unstable · source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> HasCompact for Twhere T: 'static, Compact<T>: for<'a> EncodeAsRef<'a, T> + Decode + From<T> + Into<T>,

§

#### type Type = Compact<T>

The compact type; this can be
source§

### impl<T, U> Into<U> for Twhere U: From<T>,

const: unstable · source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> KeyedVec for Twhere T: Codec,

§

#### fn to_keyed_vec(&self, prepend_key: &[u8]) -> Vec<u8, Global>

Return an encoding of `Self` prepended by given slice.
source§

### impl<T> LowerBounded for Twhere T: Bounded,

source§

#### fn min_value() -> T

Returns the smallest finite number this type can represent
source§

### impl<T> SaturatedConversion for T

source§

#### fn saturated_from<T>(t: T) -> Selfwhere Self: UniqueSaturatedFrom<T>,

Convert from a value of `T` into an equivalent instance of `Self`. Read more
source§

#### fn saturated_into<T>(self) -> Twhere Self: UniqueSaturatedInto<T>,

Consume self to return an equivalent value of `T`. Read more
source§

### impl<T> ThresholdOrd<T> for Twhere T: Ord + PartialOrd<T> + Copy + Clone + Zero + Saturating,

source§

#### fn tcmp(&self, other: &T, threshold: T) -> Ordering

Compare if `self` is `threshold` greater or less than `other`.
source§

### impl<T> ToOwned for Twhere T: Clone,

§

#### type Owned = T

The resulting type after obtaining ownership.
source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

### impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

#### type Error = Infallible

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

### impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
const: unstable · source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

### impl<T, S> UniqueSaturatedFrom<T> for Swhere S: TryFrom<T> + Bounded,

source§

#### fn unique_saturated_from(t: T) -> S

Convert from a value of `T` into an equivalent instance of `Self`.
source§

### impl<T, S> UniqueSaturatedInto<T> for Swhere T: Bounded, S: TryInto<T>,

source§

#### fn unique_saturated_into(self) -> T

Consume self to return an equivalent value of `T`.
source§

### impl<T> UpperBounded for Twhere T: Bounded,

source§

#### fn max_value() -> T

Returns the largest finite number this type can represent
§

source§

§

§

§

§

§

§

§

§

§

§

§