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

#[cfg(feature = "fmt_json")]
use serde::{Deserialize, Serialize};
use std::ops::Deref;

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

///
/// A `Caption` instance holds simple plain, un-styled, text, it is intended to be included with
/// blocks that are commonly labeled such as tables, images, etc.
///
/// While some formats do allow styled text within captions, this is currently not supported. It
/// may be possible in the future to provide a styled caption with an inner list of `InlineContent`.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct Caption(String);

///
/// Implemented by values that support a caption.
///
pub trait HasCaption {
    /// Returns `true` if a caption is set, else `false`.
    fn has_caption(&self) -> bool {
        self.caption().is_some()
    }

    /// Return the caption, if present.
    fn caption(&self) -> &Option<Caption>;

    /// Set the caption to the provided value.
    fn set_caption(&mut self, caption: Caption) -> &mut Self;

    /// Set the caption to `None`.
    fn unset_caption(&mut self) -> &mut Self;
}

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

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

impl From<String> for Caption {
    fn from(inner: String) -> Self {
        Self::from(inner.as_str())
    }
}

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

impl Deref for Caption {
    type Target = str;

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

inner_impl!(Caption, String);