castep-cell-io 0.6.0

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_bool;

/// Controls whether or not different wavefunctions are used for different spins.
///
/// Keyword type: Logical
///
/// Default: false
///
/// Example:
/// SPIN_POLARIZED : TRUE
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
pub struct SpinPolarized(pub bool);

impl FromCellValue for SpinPolarized {
    fn from_cell_value(value: &CellValue<'_>) -> CResult<Self> {
        Ok(Self(value_as_bool(value)?))
    }
}

impl FromKeyValue for SpinPolarized {
    const KEY_NAME: &'static str = "SPIN_POLARIZED";

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

impl ToCell for SpinPolarized {
    fn to_cell(&self) -> Cell<'_> {
        Cell::KeyValue("SPIN_POLARIZED", CellValue::Bool(self.0))
    }
}

impl ToCellValue for SpinPolarized {
    fn to_cell_value(&self) -> CellValue<'_> {
        CellValue::Bool(self.0)
    }
}

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

    #[test]
    fn test_from_cell_value_true() {
        let val = CellValue::Bool(true);
        assert_eq!(SpinPolarized::from_cell_value(&val).unwrap().0, true);
    }

    #[test]
    fn test_from_cell_value_false() {
        let val = CellValue::Bool(false);
        assert_eq!(SpinPolarized::from_cell_value(&val).unwrap().0, false);
    }

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