Struct StoichiometricCoefficient 

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

A nonzero stoichiometric coefficient.

Implementations

impl StoichiometricCoefficient

pub const fn new( value: u32, ) -> Result<StoichiometricCoefficient, StoichiometryValidationError>

Creates a stoichiometric coefficient.

Errors

Returns StoichiometryValidationError::ZeroCoefficient when value is zero.

pub const fn value(self) -> u32

Returns the coefficient value.

pub const fn is_one(self) -> bool

Returns true when the coefficient is one.

Trait Implementations

impl Clone for StoichiometricCoefficient

fn clone(&self) -> StoichiometricCoefficient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StoichiometricCoefficient

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

Formats the value using the given formatter.

impl Display for StoichiometricCoefficient

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

Formats the value using the given formatter.

impl Hash for StoichiometricCoefficient

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 StoichiometricCoefficient

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

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

fn partial_cmp(&self, other: &StoichiometricCoefficient) -> 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 TryFrom<u32> for StoichiometricCoefficient

type Error = StoichiometryValidationError

The type returned in the event of a conversion error.

fn try_from( value: u32, ) -> Result<StoichiometricCoefficient, <StoichiometricCoefficient as TryFrom<u32>>::Error>

Performs the conversion.

impl Copy for StoichiometricCoefficient

impl Eq for StoichiometricCoefficient

impl StructuralPartialEq for StoichiometricCoefficient