Struct PolyatomicIon 

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

A polyatomic ion wrapper.

Implementations

impl PolyatomicIon

pub fn new( formula: ChemicalFormula, charge: IonCharge, ) -> Result<PolyatomicIon, IonValidationError>

Creates a polyatomic ion from a formula and charge.

Errors

Returns IonValidationError::ExpectedPolyatomicFormula when formula does not contain more than one atom.

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

Wraps an existing ion after polyatomic formula validation.

Errors

Returns IonValidationError::ExpectedPolyatomicFormula when the ion formula does not contain more than one atom.

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 PolyatomicIon

fn clone(&self) -> PolyatomicIon

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PolyatomicIon

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

Formats the value using the given formatter.

impl Display for PolyatomicIon

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

Formats the value using the given formatter.

impl PartialEq for PolyatomicIon

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

impl StructuralPartialEq for PolyatomicIon