somedoc 0.2.10

A very simple document model and markup generator.
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179

use crate::error;
use crate::model::inline::Character;
use crate::model::inline::{HasInlineContent, InlineContent};
use crate::model::{HasInnerContent, HasStyles, Style};
#[cfg(feature = "fmt_json")]
use serde::{Deserialize, Serialize};
use std::ops::Deref;

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

///
/// These represent styles that may be applied to a single `Span`. Note that they will be applied in
/// the order they were added to the span. Writers should simply ignore styles they do not support.
///
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub enum SpanStyle {
    Plain,
    Italic,
    Bold,
    Mono,
    Code,
    Strikethrough,
    Underline,
    SmallCaps,
    Superscript,
    Subscript,
    Sized(Size),
}

///
/// A size modifier for styling a `Span`.
///
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub enum Size {
    Largest,
    Larger,
    Large,
    Normal,
    Small,
    Smaller,
    Smallest,
}

///
/// A span consists of a list of styles to apply to an inner list of inline content.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct Span {
    inner: Vec<InlineContent>,
    #[cfg_attr(feature = "fmt_json", serde(skip_serializing_if = "Vec::is_empty"))]
    #[cfg_attr(feature = "fmt_json", serde(default))]
    styles: Vec<SpanStyle>,
}

///
/// A `Text` instance holds simple plain, un-styled, text.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct Text(String);

// ------------------------------------------------------------------------------------------------
// Implementations
// ------------------------------------------------------------------------------------------------

impl Default for SpanStyle {
    fn default() -> Self {
        Self::Plain
    }
}

impl Style for SpanStyle {}

// ------------------------------------------------------------------------------------------------

impl Default for Size {
    fn default() -> Self {
        Self::Normal
    }
}

// ------------------------------------------------------------------------------------------------

impl Default for Text {
    fn default() -> Self {
        Self(String::new())
    }
}

impl From<String> for Text {
    fn from(s: String) -> Self {
        Self(s)
    }
}

impl From<&str> for Text {
    fn from(s: &str) -> Self {
        Self(s.to_string())
    }
}

impl Deref for Text {
    type Target = str;

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}

inline_impls!(Text);

inner_impl!(Text, String);

impl Text {
    /// Create a new Text instance from the string.
    pub fn new(s: &str) -> Self {
        Self(s.to_string())
    }
}

// ------------------------------------------------------------------------------------------------

impl Default for Span {
    fn default() -> Self {
        Self {
            inner: Default::default(),
            styles: Default::default(),
        }
    }
}

inline_impls!(Span);

has_inline_impls!(Span);

has_styles_impls!(Span, SpanStyle);

impl Span {
    /// Create a new span, with the provided style, that includes a `Text` instance.
    pub fn with_style(inner: &str, style: SpanStyle) -> Self {
        Self {
            inner: vec![Text::from(inner).into()],
            styles: vec![style],
        }
    }
    /// Create a new span, with the provided styles, that includes a `Text` instance.
    pub fn with_styles(inner: &str, styles: Vec<SpanStyle>) -> Self {
        Self {
            inner: vec![Text::from(inner).into()],
            styles,
        }
    }

    /// Create a new span, with the provided style, that includes a `InlineContent` instance.
    pub fn inner_with_style(inner: InlineContent, style: SpanStyle) -> Self {
        Self {
            inner: vec![inner],
            styles: vec![style],
        }
    }

    /// Create a new span, with the provided style, that includes a `InlineContent` instance.
    pub fn inner_with_styles(inner: InlineContent, styles: Vec<SpanStyle>) -> Self {
        Self {
            inner: vec![inner],
            styles,
        }
    }

    /// Create a new span containing simply a space character.
    pub fn space() -> Self {
        Self::from(InlineContent::from(Character::Space.into()))
    }
}