Struct IonCharge 

pub struct IonCharge { /* private fields */ }

A nonzero signed ionic charge.

Implementations

impl IonCharge

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

Creates a positive ion charge.

Errors

Returns IonValidationError::ZeroChargeMagnitude when magnitude is zero.

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

Creates a negative ion charge.

Errors

Returns IonValidationError::ZeroChargeMagnitude when magnitude is zero.

pub const fn sign(self) -> ChargeSign

Returns the charge sign.

pub const fn magnitude(self) -> u8

Returns the charge magnitude as a primitive value.

pub const fn magnitude_value(self) -> ChargeMagnitude

Returns the charge magnitude wrapper.

pub const fn is_positive(self) -> bool

Returns true for a positive charge.

pub const fn is_negative(self) -> bool

Returns true for a negative charge.

pub const fn is_cation(self) -> bool

Returns true for a cation charge.

pub const fn is_anion(self) -> bool

Returns true for an anion charge.

Trait Implementations

impl Clone for IonCharge

fn clone(&self) -> IonCharge

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IonCharge

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

Formats the value using the given formatter.

impl Display for IonCharge

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

Formats the value using the given formatter.

impl Hash for IonCharge

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 IonCharge

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

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

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

impl Eq for IonCharge

impl StructuralPartialEq for IonCharge