Enum Percentage 

pub enum Percentage<T> {
    Fraction(Fraction<T>),
    Points(Points<T>),
}

Percentage type that tracks whether the intenal value represents percentage points or a fractional part.

Variants

Fraction(Fraction<T>)

Internal value is fractional

Points(Points<T>)

Internal value is points

Implementations

impl<T> Percentage<T>

where T: Number,

pub const fn from_fraction(fraction: T) -> Self

Construct a Percentage from a fractional value

pub const fn from_points(points: T) -> Self

Construct a Percentage from a percentage points value

pub fn to_fraction(self) -> T

Obtain the fractional representation of the Percentage

pub fn to_points(self) -> T

Obtain the points representation of the Percentage

pub fn to_fraction_mut(&mut self) -> &mut T

Mutate the inner value as a fraction

pub fn to_points_mut(&mut self) -> &mut T

Mutate the inner value as points

pub fn update_fraction(&mut self, f: impl FnOnce(T) -> T)

In-place update the inner value as a fraction

pub fn update_points(&mut self, f: impl FnOnce(T) -> T)

In-place update the inner value as points

pub fn apply_to(self, other: T) -> T

Compute the quantity that represents the percentage of other

pub fn gain_loss(final_value: T, initial_value: T) -> Option<Self>

Compute the percentage gained or lost between the initial and final value.

pub fn part_of_the_whole(part: T, whole: T) -> Option<Self>

Compute the percentage of the whole represented by the part

Trait Implementations

impl Add<Percentage<f32>> for f32

type Output = f32

The resulting type after applying the + operator.

fn add(self, rhs: Percentage<f32>) -> Self::Output

Performs the + operation.

impl Add<Percentage<f64>> for f64

type Output = f64

The resulting type after applying the + operator.

fn add(self, rhs: Percentage<f64>) -> Self::Output

Performs the + operation.

impl<T> Add for Percentage<T>

where T: Number,

type Output = Percentage<T>

The resulting type after applying the + operator.

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

Performs the + operation.

impl<T: Clone> Clone for Percentage<T>

fn clone(&self) -> Percentage<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Percentage<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Display for Percentage<T>

where T: Number + Display,

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

Formats the value using the given formatter.

impl<T> PartialEq for Percentage<T>

where T: Number,

fn eq(&self, other: &Self) -> 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<T> PartialOrd for Percentage<T>

where T: Number,

fn partial_cmp(&self, other: &Self) -> 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 Sub<Percentage<f32>> for f32

type Output = f32

The resulting type after applying the - operator.

fn sub(self, rhs: Percentage<f32>) -> Self::Output

Performs the - operation.

impl Sub<Percentage<f64>> for f64

type Output = f64

The resulting type after applying the - operator.

fn sub(self, rhs: Percentage<f64>) -> Self::Output

Performs the - operation.

impl<T> Sub for Percentage<T>

where T: Number,

type Output = Percentage<T>

The resulting type after applying the - operator.

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

Performs the - operation.

impl<T: Copy> Copy for Percentage<T>