Struct OxidationState 

pub struct OxidationState { /* private fields */ }

A validated oxidation-state value.

Implementations

impl OxidationState

pub const fn new( sign: OxidationSign, magnitude: OxidationMagnitude, ) -> Result<Self, OxidationStateValidationError>

Creates an oxidation state from a sign and magnitude.

Errors

Returns OxidationStateValidationError::ZeroSignedMagnitude when a positive or negative state uses zero magnitude, or OxidationStateValidationError::NonZeroZeroMagnitude when a zero state uses a nonzero magnitude.

pub fn positive(magnitude: u8) -> Result<Self, OxidationStateValidationError>

Creates a positive oxidation state.

Errors

Returns OxidationStateValidationError::ZeroSignedMagnitude when magnitude is zero, or OxidationStateValidationError::MagnitudeAboveMaximum when it is above the supported range.

pub fn negative(magnitude: u8) -> Result<Self, OxidationStateValidationError>

Creates a negative oxidation state.

Errors

Returns OxidationStateValidationError::ZeroSignedMagnitude when magnitude is zero, or OxidationStateValidationError::MagnitudeAboveMaximum when it is above the supported range.

pub const fn zero() -> Self

Creates a zero oxidation state.

pub const fn sign(self) -> OxidationSign

Returns the oxidation-state sign.

pub const fn magnitude(self) -> OxidationMagnitude

Returns the oxidation-state magnitude.

pub const fn magnitude_value(self) -> u8

Returns the oxidation-state magnitude value.

pub const fn signed_value(self) -> i8

Returns the signed oxidation-state value.

pub const fn is_positive(self) -> bool

Returns true for positive oxidation states.

pub const fn is_negative(self) -> bool

Returns true for negative oxidation states.

pub const fn is_zero(self) -> bool

Returns true for zero oxidation states.

pub fn to_roman(self) -> Option<String>

Returns the Roman numeral for the nonzero magnitude.

Trait Implementations

impl Clone for OxidationState

fn clone(&self) -> OxidationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OxidationState

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

Formats the value using the given formatter.

impl Default for OxidationState

fn default() -> Self

Returns the “default value” for a type.

impl Display for OxidationState

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

Formats the value using the given formatter.

impl Hash for OxidationState

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

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 OxidationState

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

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

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

impl Eq for OxidationState

impl StructuralPartialEq for OxidationState