khive-types 0.13.0

//! Substrate discriminant — the 3 data types in khive.
//!
//! Full substrate structs live in the sibling modules (`note`, `entity`,
//! `event`). This module provides the discriminant for typed dispatch and
//! persistence.

use core::fmt;
use core::str::FromStr;

/// The 3 substrate types in khive OSS.
///
/// - **Note**: temporal-referential records (observations, insights, decisions)
/// - **Entity**: graph nodes with properties and typed links
/// - **Event**: universal system log — every verb execution produces one
#[repr(u8)]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "serde", serde(rename_all = "snake_case"))]
pub enum SubstrateKind {
    Note = 0,
    Entity = 1,
    Event = 2,
}

/// Total number of substrate kinds. Matches the length of [`SubstrateKind::ALL`].
pub const SUBSTRATE_COUNT: usize = 3;

impl SubstrateKind {
    /// All substrate kinds in discriminant order.
    pub const ALL: [SubstrateKind; SUBSTRATE_COUNT] = [
        SubstrateKind::Note,
        SubstrateKind::Entity,
        SubstrateKind::Event,
    ];

    /// Return the canonical lowercase name for this substrate, as stored on the wire.
    #[inline]
    pub const fn name(self) -> &'static str {
        match self {
            Self::Note => "note",
            Self::Entity => "entity",
            Self::Event => "event",
        }
    }

    /// Construct a `SubstrateKind` from its `u8` discriminant, or `None` if out of range.
    #[inline]
    pub const fn from_u8(v: u8) -> Option<Self> {
        match v {
            0 => Some(Self::Note),
            1 => Some(Self::Entity),
            2 => Some(Self::Event),
            _ => None,
        }
    }
}

impl fmt::Display for SubstrateKind {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str(self.name())
    }
}

const SUBSTRATE_KIND_VALID: &[&str] = &["note", "entity", "event"];

impl FromStr for SubstrateKind {
    type Err = crate::error::UnknownVariant;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        match s {
            "note" | "Note" => Ok(Self::Note),
            "entity" | "Entity" => Ok(Self::Entity),
            "event" | "Event" => Ok(Self::Event),
            other => Err(crate::error::UnknownVariant::new(
                "substrate_kind",
                other,
                SUBSTRATE_KIND_VALID,
            )),
        }
    }
}

#[cfg(test)]
#[path = "substrate_tests.rs"]
mod tests;