serde_markdown 0.5.1

Serde format crate: Rust structs to and from Markdown documents
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Hand-written structs that mirror `proto/markdown/testdata`.
//!
//! [`Markdown::BODY_FIELDS`] lists Serde field names (after `rename`) in
//! declaration order.

use buffa_types::google::protobuf::{Duration, Empty, FieldMask, Int32Value, Struct, Timestamp};
use serde::{Deserialize, Serialize};

use serde_markdown_derive::Markdown;

/// Fixture page (`markdown.testdata.Page`).
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Markdown)]
pub struct Page {
    pub field1: String,
    pub field2: String,
    pub field3: i32,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub published: Option<Timestamp>,
    #[markdown(body)]
    pub text1: String,
    #[markdown(body)]
    pub appendix: String,
}

/// No body sections (`markdown.testdata.FieldsOnly`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct FieldsOnly {
    pub name: String,
    pub count: i32,
}

/// Body-only document (`markdown.testdata.BodyOnly`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct BodyOnly {
    #[markdown(body)]
    pub text1: String,
    #[markdown(body)]
    pub text2: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Meta {
    pub author: String,
    pub tags: Vec<String>,
}

/// Nested front matter (`markdown.testdata.NestedFields`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct NestedFields {
    pub meta: Meta,
    pub draft: bool,
    #[markdown(body)]
    pub body: String,
}

/// Presence matrix (`markdown.testdata.OptionalBody`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct OptionalBody {
    pub title: String,
    #[markdown(body)]
    pub first: Option<String>,
    #[markdown(body)]
    pub middle: Option<String>,
    #[markdown(body)]
    pub last: Option<String>,
}

/// Snake_case identifiers, camelCase Markdown keys (`markdown.testdata.JsonNames`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct JsonNames {
    #[serde(rename = "publishedAt")]
    pub published_at: String,
    #[serde(rename = "bodyNote")]
    #[markdown(body)]
    pub body_note: String,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
pub struct Note {
    pub heading: String,
    pub pages: i32,
}

/// Structured body section (`markdown.testdata.Article`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct Article {
    pub title: String,
    #[markdown(body)]
    pub note: Note,
}

/// WKT in fields and body (`markdown.testdata.WellKnown`).
///
/// Field types are `buffa_types` well-known messages so proto3 JSON serde
/// supplies RFC 3339 / duration / field-mask mapping. This crate does not
/// parse those strings itself.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, Markdown)]
pub struct WellKnown {
    pub published: Timestamp,
    pub ttl: Duration,
    pub meta: Empty,
    pub extra: Struct,
    pub mask: FieldMask,
    pub count: Int32Value,
    #[serde(rename = "occurredAt")]
    #[markdown(body)]
    pub occurred_at: Timestamp,
    #[markdown(body)]
    pub pause: Duration,
}

/// proto3 `optional` body (`markdown.testdata.Proto3Page`).
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Markdown)]
pub struct Proto3Page {
    pub title: String,
    #[markdown(body)]
    pub body: Option<String>,
}