castep-cell-io 0.6.0

I/O library for CASTEP .cell and .param file formats
Documentation
use castep_cell_fmt::{Cell, CellValue, ToCell, ToCellValue};
use castep_cell_fmt::parse::{FromCellValue, FromKeyValue};
use castep_cell_fmt::{CResult, Error};
use castep_cell_fmt::query::value_as_str;

/// Specifies which non-linear optical property to calculate during a TASK=EFIELD calculation.
///
/// Keyword type: String
///
/// Default: EfieldCalculateNonlinear::None
///
/// Example:
/// EFIELD_CALCULATE_NONLINEAR : CHI2
#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq)]
#[derive(Default)]
pub enum EfieldCalculateNonlinear {
    /// Produces second harmonic generation coefficients
    Chi2,
    /// Non-linear optical properties are not calculated
    #[default]
    None,
}


impl FromCellValue for EfieldCalculateNonlinear {
    fn from_cell_value(value: &CellValue<'_>) -> CResult<Self> {
        match value_as_str(value)?.to_ascii_lowercase().as_str() {
            "chi2" => Ok(Self::Chi2),
            "none" => Ok(Self::None),
            other => Err(Error::Message(format!("unknown EfieldCalculateNonlinear: {other}"))),
        }
    }
}

impl FromKeyValue for EfieldCalculateNonlinear {
    const KEY_NAME: &'static str = "EFIELD_CALCULATE_NONLINEAR";

    fn from_cell_value_kv(value: &CellValue<'_>) -> CResult<Self> {
        Self::from_cell_value(value)
    }
}

impl ToCell for EfieldCalculateNonlinear {
    fn to_cell(&self) -> Cell<'_> {
        Cell::KeyValue("EFIELD_CALCULATE_NONLINEAR", self.to_cell_value())
    }
}

impl ToCellValue for EfieldCalculateNonlinear {
    fn to_cell_value(&self) -> CellValue<'_> {
        CellValue::String(
            match self {
                EfieldCalculateNonlinear::Chi2 => "CHI2",
                EfieldCalculateNonlinear::None => "NONE",
            }
            .to_string(),
        )
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use castep_cell_fmt::CellValue;

    #[test]
    fn test_case_insensitive() {
        assert_eq!(EfieldCalculateNonlinear::from_cell_value(&CellValue::Str("chi2")).unwrap(), EfieldCalculateNonlinear::Chi2);
        assert_eq!(EfieldCalculateNonlinear::from_cell_value(&CellValue::Str("CHI2")).unwrap(), EfieldCalculateNonlinear::Chi2);
        assert_eq!(EfieldCalculateNonlinear::from_cell_value(&CellValue::Str("none")).unwrap(), EfieldCalculateNonlinear::None);
    }

    #[test]
    fn test_invalid() {
        assert!(EfieldCalculateNonlinear::from_cell_value(&CellValue::Str("invalid")).is_err());
    }

    #[test]
    fn test_key_name() {
        assert_eq!(EfieldCalculateNonlinear::KEY_NAME, "EFIELD_CALCULATE_NONLINEAR");
    }
}