Struct BasicPoints

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

BasicPoints struct implementation. BasicPoints value is within [0, 10000] interval. Technically BasicPoints is wrapper over u16 with additional limit checks and several implementations of math functions so BasicPoints object can be used in formulas along with Uint128 and Decimal.

Implementations

impl BasicPoints

pub const MAX: u16 = 10_000u16

pub fn checked_add(self, rhs: Self) -> Result<Self, StdError>

pub fn from_ratio( numerator: Uint128, denominator: Uint128, ) -> Result<Self, StdError>

pub fn percent(percent: u16) -> BasicPoints

pub fn reverse(self) -> BasicPoints

pub fn decimal(self) -> Decimal

pub fn div_decimal(self, rhs: Self) -> Decimal

pub const fn max() -> Self

pub const fn one() -> Self

pub const fn zero() -> Self

pub const fn u16(self) -> u16

pub const fn is_max(self) -> bool

pub const fn is_zero(self) -> bool

Trait Implementations

impl Clone for BasicPoints

fn clone(&self) -> BasicPoints

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicPoints

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

Formats the value using the given formatter.

impl Default for BasicPoints

fn default() -> BasicPoints

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BasicPoints

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BasicPoints> for Uint128

fn from(value: BasicPoints) -> Self

Converts to this type from the input type.

impl From<BasicPoints> for u16

fn from(value: BasicPoints) -> Self

Converts to this type from the input type.

impl JsonSchema for BasicPoints

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Mul<Decimal> for BasicPoints

type Output = Decimal

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<Uint128> for BasicPoints

type Output = Uint128

The resulting type after applying the * operator.

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

Performs the * operation.

impl PartialEq for BasicPoints

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Decimal> for BasicPoints

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(value: Decimal) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u128> for BasicPoints

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<u16> for BasicPoints

type Error = StdError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for BasicPoints

impl StructuralPartialEq for BasicPoints