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

use crate::error;
use crate::model::block::{BlockContent, Label};
use crate::model::inline::{HasInlineContent, InlineContent, Text};
use crate::model::{block::HasLabel, HasInnerContent};
#[cfg(feature = "fmt_json")]
use serde::{Deserialize, Serialize};
use std::convert::TryFrom;

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

///
/// The level of the heading denoting it's hierarchy.
///
#[derive(Clone, Debug, PartialEq)]
#[repr(u8)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub enum HeadingLevel {
    /// Level 1 heading/section (top-level).
    Section = 1,
    /// Level 2 heading/section.
    SubSection,
    /// Level 3 heading/section.
    SubSubSection,
    /// Level 4 heading/section.
    SubSubSubSection,
    /// Level 5 heading/section.
    SubSubSubSubSection,
    /// Level 6 heading/section.
    SubSubSubSubSubSection,
    /// Level 7 heading/section.
    SubSubSubSubSubSubSection,
}

///
/// A heading consists of a level and text. The level is indicated by `HeadingLevel` and the text
/// is an inner content list of `InlineContent` values.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct Heading {
    #[cfg_attr(feature = "fmt_json", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "fmt_json", serde(default))]
    label: Option<Label>,
    level: HeadingLevel,
    inner: Vec<InlineContent>,
}

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

impl Default for HeadingLevel {
    fn default() -> Self {
        Self::Section
    }
}

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

impl Default for Heading {
    fn default() -> Self {
        Self {
            label: None,
            level: Default::default(),
            inner: Default::default(),
        }
    }
}

impl TryFrom<u8> for HeadingLevel {
    type Error = ();

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            1 => Ok(HeadingLevel::Section),
            2 => Ok(HeadingLevel::SubSection),
            3 => Ok(HeadingLevel::SubSubSection),
            4 => Ok(HeadingLevel::SubSubSubSection),
            5 => Ok(HeadingLevel::SubSubSubSubSection),
            6 => Ok(HeadingLevel::SubSubSubSubSubSection),
            7 => Ok(HeadingLevel::SubSubSubSubSubSubSection),
            _ => Err(()),
        }
    }
}

label_impl!(Heading);

block_impls!(Heading);

has_inline_impls!(Heading);

impl Heading {
    /// Create a new heading with the given text and level.
    pub fn new(inner: &str, kind: HeadingLevel) -> Self {
        Self {
            label: None,
            level: kind,
            inner: vec![Text::from(inner).into()],
        }
    }

    /// Create a new heading with the given text and level of `HeadingLevel::Section`.
    pub fn section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::Section)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSection`.
    pub fn sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSection)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSubSection`.
    pub fn sub_sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSubSection)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSubSubSection`.
    pub fn sub_sub_sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSubSubSection)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSubSubSubSection`.
    pub fn sub_sub_sub_sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSubSubSubSection)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSubSubSubSubSection`.
    pub fn sub_sub_sub_sub_sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSubSubSubSubSection)
    }

    /// Create a new heading with the given text and level of `HeadingLevel::SubSubSubSubSubSubSection`.
    pub fn sub_sub_sub_sub_sub_sub_section(inner: &str) -> Self {
        Self::new(inner, HeadingLevel::SubSubSubSubSubSubSection)
    }

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

    /// Return the level of this heading.
    pub fn level(&self) -> &HeadingLevel {
        &self.level
    }

    /// Return the level of this heading as a `u8` value.
    pub fn level_as_u8(&self) -> u8 {
        self.level.clone() as u8
    }

    /// Set the level of this heading.
    pub fn set_level(&mut self, level: HeadingLevel) -> &mut Self {
        self.level = level;
        self
    }
}