Struct Cation 

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

A positive ion wrapper.

Implementations

impl Cation

pub fn new( formula: ChemicalFormula, magnitude: u8, ) -> Result<Self, IonValidationError>

Creates a cation from a formula and positive charge magnitude.

Errors

Returns IonValidationError::ZeroChargeMagnitude when magnitude is zero.

pub fn from_ion(ion: Ion) -> Result<Self, IonValidationError>

Wraps an existing positive ion.

Errors

Returns IonValidationError::ExpectedCation when ion has a negative charge.

pub const fn as_ion(&self) -> &Ion

Returns the wrapped ion.

pub fn into_ion(self) -> Ion

Consumes the wrapper and returns the ion.

Trait Implementations

impl Clone for Cation

fn clone(&self) -> Cation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cation

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

Formats the value using the given formatter.

impl Display for Cation

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

Formats the value using the given formatter.

impl PartialEq for Cation

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

impl StructuralPartialEq for Cation