eure-document 0.1.9

Value type 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
79
80
81
82
83
84
85
86
87
88
89

use crate::prelude_internal::*;

/// Data model of a document or a value in a document. Corresponds to the `$data-model` extension.
#[derive(Debug, Clone, Copy, PartialEq, Default)]
pub enum DataModel {
    /// Serde compatible data model.
    Rust,
    /// JSON compatible data model.
    Json,
    /// Eure full data model including path.
    #[default]
    Eure,
}

#[derive(Debug, Clone, PartialEq, Default)]
pub struct DataModelConfig {
    pub data_model: DataModel,
    pub number_key_repr: NumberKeyRepr,
    pub tuple_key_repr: TupleKeyRepr,
    pub boolean_key_repr: BooleanKeyRepr,
    pub tuple_repr: TupleRepr,
}

#[derive(Debug, Clone, PartialEq, Default)]
/// How to represent numeric keys in a data model that does not support numbers as object keys. Corresponds to the `$number-key-repr` extension.
pub enum NumberKeyRepr {
    /// Represent number as string.
    String,
    /// Error on conversion.
    #[default]
    Error,
}

#[derive(Debug, Clone, PartialEq, Default)]
/// How to represent tuple keys in a data model that does not support tuples as object keys. Corresponds to the `$tuple-key-repr` extension.
pub enum TupleKeyRepr {
    /// Represent tuple as string. e.g. "(1,2,3)".
    String,
    /// Error on conversion.
    #[default]
    Error,
}

#[derive(Debug, Clone, PartialEq, Default)]
/// How to represent boolean keys in a data model that does not support booleans as object keys. Corresponds to the `$boolean-key-repr` extension.
pub enum BooleanKeyRepr {
    /// Represent boolean as string. e.g. "true" or "false".
    String,
    /// Error on conversion.
    #[default]
    Error,
}

#[derive(Debug, Clone, PartialEq, Default)]
/// How to represent tuples in a data model that does not support tuples. Corresponds to the `$tuple-repr` extension.
pub enum TupleRepr {
    /// Represent tuple as array. e.g. "[1,2,3]".
    Array,
    /// Represent tuple as number indexed object. e.g. `{0: 1, 1: 2, 2: 3}`. `{"0": 1, "1": 2, "2": 3}` if `NumberKeyRepr` is `String`.
    NumberIndexedObject,
    /// Error on conversion.
    #[default]
    Error,
}

/// How to represent text with non-plaintext language in a data model.
///
/// This controls how `Text` values with `Language::Other(lang)` are serialized
/// to formats that don't natively support language-tagged text.
///
/// Corresponds to the `$text-repr` extension (formerly `$code-repr`).
#[derive(Debug, Clone, PartialEq, Default)]
pub enum TextRepr {
    /// Markdown code block string.
    /// e.g. "```rust\nfn main() { println!(\"Hello, world!\"); }\n```".
    Markdown,
    /// Content only string, discarding language information.
    /// e.g. "fn main() { println!(\"Hello, world!\"); }".
    String,
    /// Object with language and content fields.
    /// e.g. `{"language": "rust", "content": "fn main() { println!(\"Hello, world!\"); }"}`.
    Object {
        language_key: String,
        content_key: String,
    },
    /// Error on conversion.
    #[default]
    Error,
}