use-stoichiometry 0.1.0

use std::fmt;

use crate::StoichiometryValidationError;

/// A validated excess-reagent label.
#[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
pub struct ExcessReagent(String);

impl ExcessReagent {
    /// Creates an excess-reagent label.
    ///
    /// # Errors
    ///
    /// Returns [`StoichiometryValidationError::EmptyExcessReagentLabel`] when `label` is
    /// empty or whitespace only.
    pub fn new(label: &str) -> Result<Self, StoichiometryValidationError> {
        let label = label.trim();

        if label.is_empty() {
            Err(StoichiometryValidationError::EmptyExcessReagentLabel)
        } else {
            Ok(Self(label.to_owned()))
        }
    }

    /// Returns the label text.
    #[must_use]
    pub fn as_str(&self) -> &str {
        &self.0
    }

    /// Consumes the label and returns the owned text.
    #[must_use]
    pub fn into_string(self) -> String {
        self.0
    }
}

impl AsRef<str> for ExcessReagent {
    fn as_ref(&self) -> &str {
        self.as_str()
    }
}

impl TryFrom<&str> for ExcessReagent {
    type Error = StoichiometryValidationError;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        Self::new(value)
    }
}

impl fmt::Display for ExcessReagent {
    fn fmt(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
        formatter.write_str(self.as_str())
    }
}