Struct Percent

pub struct Percent(pub f64);

A value in percent (%).

Basic arithmetic is implemented for convenience, and the underlying f64 value is accessible as a tuple field.

Example

use mendeleev::Percent;
use core::cmp::Ordering;

let value1 = Percent(1.0);
let value2 = Percent(2.0);
assert_eq!(value1.0, 1.0);
assert!(value1 < value2);
assert_eq!(value1.total_cmp(&value2), Ordering::Less);
assert_eq!(value1 + value2, Percent(3.0));
assert_eq!(value1 - value2, Percent(-1.0));
assert_eq!(value1 * 5.0, Percent(5.0));
assert_eq!(value1 / 4.0, Percent(0.25));

Tuple Fields

0: f64

Implementations

impl Percent

pub fn total_cmp(&self, other: &Self) -> Ordering

Return the ordering between self and other.

This simply calls f64::total_cmp on the inner value.

Trait Implementations

impl Add for Percent

type Output = Percent

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for Percent

fn clone(&self) -> Percent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Percent

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

Formats the value using the given formatter.

impl Display for Percent

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

Displays the value along with the unit. Supports numeric formatting.

A space is added between the number and the unit, in accordance with the SI convention.

Example

use mendeleev::Percent;

let value = Percent(1.2345);
assert_eq!(format!("{value:.1}"), "1.2 %");

impl Div<f64> for Percent

type Output = Percent

The resulting type after applying the / operator.

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

Performs the / operation.

impl Mul<f64> for Percent

type Output = Percent

The resulting type after applying the * operator.

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

Performs the * operation.

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

type Output = Percent

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Percent

impl StructuralPartialEq for Percent