Struct Nuclide

pub struct Nuclide {
    pub symbol: String,
    pub isotope: u16,
    pub state: IsomerState,
}

Definition for a particular nuclide

The TryFrom trait is implemented for core string types and will try to parse them into a nuclide.

Expects <element><separator><isotope><metastable> at most but only the element is required. e.g.

• Element only => Co, C
• Isotope => Co60, C12
• Metastable => Co60m1 Co60m2 Co60m3 …
• Fispact => Co60m Co60n Co60mo

This order must be enforced because something like “104mn” is ambiguous. i.e. should it be interpreted as Mn-104 or N-104m?

Note that the metastable state should be the ENSDF notation (m1, m2, m3, etc…).

The metastable symbol can be converted from anything ending with the FISPACT-II notation of m, n, etc…, but it can not be guaranteed that this is a 1:1 mapping.

// Get the variant from an IAEA symbol
assert_eq!(
    Nuclide::try_from("eu-152m2").unwrap(),
    Nuclide {
        symbol: "Eu".to_string(),
        isotope: 152,
        state: IsomerState::Excited(2)
    }
);

Fields

symbol: String

Element

isotope: u16

Isotope number (Z+N, total nucleons)

state: IsomerState

Excited state status

Implementations

impl Nuclide

pub fn name(&self) -> String

A basic name for the nuclide

The nuclide name will be formatted as <element><isotope number> to provide a display name with consistent formatting.

For example:

let mut nuclide = Nuclide {
    symbol: "eu".to_string(),
    isotope: 152,
    state: IsomerState::Ground
};

// Get a display name for the nuclide
assert_eq!(nuclide.name(), "Eu152");

pub fn name_with_state(&self) -> String

A name for the nuclide including isomer state

The nuclide name will be formatted as <element><isotope number><state>

For example:

let nuclide = Nuclide {
    symbol: "eu".to_string(),
    isotope: 152,
    state: IsomerState::Excited(1)
};

// Get a display name for the excited nuclide
assert_eq!(nuclide.name_with_state(), "Eu152m1");

pub fn query_name(&self) -> Result<String, Error>

Name formatted for IAEA queries

The IAEA API expects the nuclide as <mass><element> with no state information.

Calls to this method for elements (i.e. mass set to 0) will return an error.

For example:

let nuclide = Nuclide {
    symbol: "eu".to_string(),
    isotope: 152,
    state: IsomerState::Excited(1)
};

// Get the format expected for the IAEA API query
assert_eq!(nuclide.query_name().unwrap(), "152eu");

Trait Implementations

impl Clone for Nuclide

fn clone(&self) -> Nuclide

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Nuclide

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

Formats the value using the given formatter.

impl Default for Nuclide

fn default() -> Nuclide

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Nuclide

fn deserialize<__D>( __deserializer: __D, ) -> Result<Nuclide, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Nuclide

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

Formats the value using the given formatter.

impl Ord for Nuclide

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

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

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

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Nuclide, Error>

Performs the conversion.

impl TryFrom<&str> for Nuclide

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Nuclide, <Nuclide as TryFrom<&str>>::Error>

Performs the conversion.

impl TryFrom<String> for Nuclide

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Nuclide, Error>

Performs the conversion.

impl Eq for Nuclide

impl StructuralPartialEq for Nuclide