eure-schema 0.1.8

Schema specification and validation for Eure
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
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

//! Schema-model code generation metadata types.

use eure_macros::{FromEure, IntoEure};

/// Root-level codegen settings (`$codegen`).
#[derive(Debug, Clone, Default, PartialEq, Eq, FromEure, IntoEure)]
#[eure(crate = eure_document)]
pub struct RootCodegen {
    /// Override root generated type name.
    #[eure(rename = "type", default)]
    pub type_name: Option<String>,
}

/// Root-level default codegen settings (`$codegen-defaults`).
#[derive(Debug, Clone, Default, PartialEq, Eq, FromEure, IntoEure)]
#[eure(crate = eure_document, rename_all = "kebab-case")]
pub struct CodegenDefaults {
    /// Default derives for emitted Rust types.
    #[eure(default)]
    pub derive: Option<Vec<String>>,
    /// Prefix for generated extension field names.
    #[eure(default)]
    pub ext_types_field_prefix: Option<String>,
    /// Prefix for generated extension type names.
    #[eure(default)]
    pub ext_types_type_prefix: Option<String>,
    /// Optional document node id field name.
    #[eure(default)]
    pub document_node_id_field: Option<String>,
}

/// Record type-level codegen metadata (`$codegen` on record schema nodes).
#[derive(Debug, Clone, Default, PartialEq, Eq, FromEure, IntoEure)]
#[eure(crate = eure_document)]
pub struct RecordCodegen {
    /// Override generated Rust type name.
    #[eure(rename = "type", default)]
    pub type_name: Option<String>,
    /// Override derives for this type.
    #[eure(default)]
    pub derive: Option<Vec<String>>,
}

/// Union type-level codegen metadata (`$codegen` on union schema nodes).
#[derive(Debug, Clone, Default, PartialEq, Eq, FromEure, IntoEure)]
#[eure(crate = eure_document, rename_all = "kebab-case")]
pub struct UnionCodegen {
    /// Override generated Rust type name.
    #[eure(rename = "type", default)]
    pub type_name: Option<String>,
    /// Override derives for this type.
    #[eure(default)]
    pub derive: Option<Vec<String>>,
    /// Generate dedicated types for variants.
    #[eure(default)]
    pub variant_types: Option<bool>,
    /// Suffix for generated variant types.
    #[eure(default)]
    pub variant_types_suffix: Option<String>,
}

/// Field-level codegen metadata (`$codegen` on record field entries).
#[derive(Debug, Clone, Default, PartialEq, Eq, FromEure, IntoEure)]
#[eure(crate = eure_document)]
pub struct FieldCodegen {
    /// Override generated Rust field name.
    #[eure(default)]
    pub name: Option<String>,
}

/// Type-level codegen metadata for schema nodes.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub enum TypeCodegen {
    #[default]
    None,
    Record(RecordCodegen),
    Union(UnionCodegen),
}