Struct OxidationMagnitude 

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

A bounded oxidation-state magnitude.

Implementations

impl OxidationMagnitude

pub const MAX: u8 = 8

The maximum magnitude supported by this crate.

pub const ZERO: OxidationMagnitude

Zero magnitude.

pub const fn new( magnitude: u8, ) -> Result<OxidationMagnitude, OxidationStateValidationError>

Creates an oxidation-state magnitude.

Errors

Returns OxidationStateValidationError::MagnitudeAboveMaximum when magnitude is greater than Self::MAX.

pub const fn get(self) -> u8

Returns the magnitude value.

pub const fn is_zero(self) -> bool

Returns true when the magnitude is zero.

Trait Implementations

impl Clone for OxidationMagnitude

fn clone(&self) -> OxidationMagnitude

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OxidationMagnitude

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

Formats the value using the given formatter.

impl Default for OxidationMagnitude

fn default() -> OxidationMagnitude

Returns the “default value” for a type.

impl Display for OxidationMagnitude

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

Formats the value using the given formatter.

impl Hash for OxidationMagnitude

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for OxidationMagnitude

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

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

fn partial_cmp(&self, other: &OxidationMagnitude) -> 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 Copy for OxidationMagnitude

impl Eq for OxidationMagnitude

impl StructuralPartialEq for OxidationMagnitude