idiolect-records 0.10.0

// @generated by idiolect-codegen. do not edit.
// source: dev.panproto.schema.protocol

//! Generated from `dev.panproto.schema.protocol`.

#![allow(
    missing_docs,
    clippy::doc_markdown,
    clippy::struct_excessive_bools,
    clippy::derive_partial_eq_without_eq,
    clippy::large_enum_variant
)]
use serde::{Deserialize, Serialize};

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PanprotoProtocol {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub category: Option<PanprotoProtocolCategory>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub constraint_sorts: Option<Vec<String>>,
    pub created_at: idiolect_records::Datetime,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub edge_rules: Option<Vec<EdgeRule>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_causal: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_coercions: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_coproducts: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_defaults: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_mergers: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_order: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub has_recursion: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instance_composition: Option<CompositionSpec>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instance_theory: Option<String>,
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub nominal_identity: Option<bool>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub obj_kinds: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema_composition: Option<CompositionSpec>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema_theory: Option<String>,
}

impl crate::Record for PanprotoProtocol {
    const NSID: &'static str = "dev.panproto.schema.protocol";
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CompositionSpec {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub shared_sorts: Option<Vec<String>>,
    pub theories: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EdgeRule {
    pub edge_kind: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub src_kinds: Option<Vec<String>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub tgt_kinds: Option<Vec<String>>,
}

/// PanprotoProtocolCategory. Open-enum slug; known values are kebab-cased; community-extended values pass through as `Other(String)`.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub enum PanprotoProtocolCategory {
    SchemaLanguage,
    ProgrammingLanguage,
    Serialization,
    DataScience,
    Api,
    Database,
    Config,
    Domain,
    Annotation,
    RawFile,
    /// Community-extended slug not present in the lexicon's
    /// `knownValues`. Resolves through the sibling
    /// `*Vocab` field on the containing record.
    Other(String),
}
impl PanprotoProtocolCategory {
    /// Wire-form slug for this value. Known variants render
    /// kebab-case; the fallback variant passes through verbatim.
    #[must_use]
    pub fn as_str(&self) -> &str {
        match self {
            Self::SchemaLanguage => "schemaLanguage",
            Self::ProgrammingLanguage => "programmingLanguage",
            Self::Serialization => "serialization",
            Self::DataScience => "dataScience",
            Self::Api => "api",
            Self::Database => "database",
            Self::Config => "config",
            Self::Domain => "domain",
            Self::Annotation => "annotation",
            Self::RawFile => "rawFile",
            Self::Other(s) => s.as_str(),
        }
    }
    /// Whether this slug is subsumed by `ancestor` under the
    /// `subsumed_by` relation in the supplied vocab. Reflexive:
    /// every slug is subsumed by itself.
    #[must_use]
    pub fn is_subsumed_by(
        &self,
        vocab: &idiolect_records::vocab::VocabGraph,
        ancestor: &str,
    ) -> bool {
        vocab.is_subsumed_by(self.as_str(), ancestor)
    }
    /// Whether this slug satisfies a requirement of `target`
    /// under the named `relation` in the supplied vocab.
    /// Generalises `is_subsumed_by` to any directed relation
    /// (e.g. `stronger_than`, `provides_at_least`,
    /// `equivalent_to`). Reflexive: a slug satisfies itself.
    #[must_use]
    pub fn satisfies(
        &self,
        vocab: &idiolect_records::vocab::VocabGraph,
        relation: &str,
        target: &str,
    ) -> bool {
        if self.as_str() == target {
            return true;
        }
        vocab
            .walk_relation(self.as_str(), relation, false)
            .iter()
            .any(|n| n == target)
    }
    /// Translate this slug across vocabularies via
    /// `equivalent_to` edges. Returns the translated slug as
    /// a target enum value when a translation exists, `None`
    /// when no path is found (callers fall back to passing
    /// the slug through verbatim, which is wire-compatible).
    #[must_use]
    pub fn translate_to<T: From<String>>(
        &self,
        src_vocab_uri: &str,
        tgt_vocab_uri: &str,
        registry: &idiolect_records::vocab::VocabRegistry,
    ) -> Option<T> {
        registry
            .translate(src_vocab_uri, tgt_vocab_uri, self.as_str())
            .map(T::from)
    }
}
impl From<String> for PanprotoProtocolCategory {
    fn from(s: String) -> Self {
        match s.as_str() {
            "schemaLanguage" => Self::SchemaLanguage,
            "programmingLanguage" => Self::ProgrammingLanguage,
            "serialization" => Self::Serialization,
            "dataScience" => Self::DataScience,
            "api" => Self::Api,
            "database" => Self::Database,
            "config" => Self::Config,
            "domain" => Self::Domain,
            "annotation" => Self::Annotation,
            "rawFile" => Self::RawFile,
            _ => Self::Other(s),
        }
    }
}
impl From<&str> for PanprotoProtocolCategory {
    fn from(s: &str) -> Self {
        match s {
            "schemaLanguage" => Self::SchemaLanguage,
            "programmingLanguage" => Self::ProgrammingLanguage,
            "serialization" => Self::Serialization,
            "dataScience" => Self::DataScience,
            "api" => Self::Api,
            "database" => Self::Database,
            "config" => Self::Config,
            "domain" => Self::Domain,
            "annotation" => Self::Annotation,
            "rawFile" => Self::RawFile,
            _ => Self::Other(s.to_owned()),
        }
    }
}
impl serde::Serialize for PanprotoProtocolCategory {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_str(self.as_str())
    }
}
impl<'de> serde::Deserialize<'de> for PanprotoProtocolCategory {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        Ok(Self::from(s))
    }
}