Struct ElementOxidationState 

pub struct ElementOxidationState { /* private fields */ }

An oxidation-state assignment for an element symbol.

Implementations

impl ElementOxidationState

pub fn new( element_symbol: &str, state: OxidationState, ) -> Result<ElementOxidationState, OxidationStateValidationError>

Creates an element oxidation-state assignment.

Errors

Returns OxidationStateValidationError::EmptyElementSymbol when element_symbol is empty or whitespace only, or OxidationStateValidationError::InvalidElementSymbol when the symbol does not match the supported shape.

pub fn element_symbol(&self) -> &str

Returns the element symbol.

pub const fn state(&self) -> OxidationState

Returns the assigned oxidation state.

pub fn into_parts(self) -> (String, OxidationState)

Consumes the assignment and returns its parts.

Trait Implementations

impl Clone for ElementOxidationState

fn clone(&self) -> ElementOxidationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ElementOxidationState

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

Formats the value using the given formatter.

impl Display for ElementOxidationState

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

Formats the value using the given formatter.

impl Hash for ElementOxidationState

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 PartialEq for ElementOxidationState

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

impl StructuralPartialEq for ElementOxidationState