idiolect-records 0.1.0

Rust record types mirroring the dev.idiolect.* Lexicon family.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57

// @generated by idiolect-codegen. do not edit.
// source: dev.idiolect.dialect

//! A community's bundle of idiolect references and preferred translations. Dialects are declared, not imposed; downstream consumers may adopt, adapt, or ignore them per P1.

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

/// A dialect is a coherent bundle of schema choices and translations a community has converged on. It is the community-level analog of an idiolect.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Dialect {
    pub created_at: String,
    /// Idiolect or lens references that were once part of this dialect and are now deprecated. Retained for migration and traceability.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub deprecations: Option<Vec<DialectDeprecations>>,
    /// Purpose and scope of this dialect.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The schemas that constitute this dialect's idiolect set.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub idiolects: Option<Vec<super::defs::SchemaRef>>,
    /// Human-readable dialect name.
    pub name: String,
    /// The community that owns this dialect.
    pub owning_community: String,
    /// Translations the community prefers when mapping between its idiolects and external schemas.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub preferred_lenses: Option<Vec<super::defs::LensRef>>,
    /// AT-URI of the immediately preceding dialect revision, forming a version chain.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub previous_version: Option<String>,
    /// Dialect version (semver when applicable).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub version: Option<String>,
}

impl crate::Record for Dialect {
    const NSID: &'static str = "dev.idiolect.dialect";
}

#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DialectDeprecations {
    pub deprecated_at: String,
    pub reason: String,
    /// The deprecated idiolect or lens.
    pub r#ref: String,
    /// Optional successor.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub replacement: Option<String>,
}