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

use crate::model::block::BlockContent;
use crate::model::inline::InlineContent;
#[cfg(feature = "fmt_json")]
use serde::{Deserialize, Serialize};

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

///
/// An image, identified by the linked content.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct Image {
    path_or_label: String,
    alt_text: Option<String>,
}

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

impl From<String> for Image {
    fn from(inner: String) -> Self {
        Self::new(&inner)
    }
}

impl From<&str> for Image {
    fn from(inner: &str) -> Self {
        Self::new(inner)
    }
}

impl Into<BlockContent> for Image {
    fn into(self) -> BlockContent {
        BlockContent::ImageBlock(self.into())
    }
}

inline_impls!(Image);

inner_impl!(Image, String, path_or_label);

impl Image {
    /// Construct a new image from the provided path (URL) or label (internal anchor).
    ///
    /// This will panic if `path_or_label` is empty.
    pub fn new(path_or_label: &str) -> Self {
        assert!(!path_or_label.is_empty());
        Self {
            path_or_label: path_or_label.to_string(),
            alt_text: None,
        }
    }

    /// Construct a new image from the provided path (URL) or label (internal anchor) with an
    /// additional `alt_text`.
    ///
    /// This will panic if either `path_or_label` or `alt_text` is empty.
    pub fn with_alt_text(path_or_label: &str, alt_text: &str) -> Self {
        assert!(!path_or_label.is_empty());
        assert!(!alt_text.is_empty());
        Self {
            path_or_label: path_or_label.to_string(),
            alt_text: Some(alt_text.to_string()),
        }
    }

    /// Returns `true` if this Image has an alternative text value, else `false`.
    pub fn has_alt_text(&self) -> bool {
        self.alt_text.is_some()
    }

    /// Returns the current alternative text value.
    pub fn alt_text(&self) -> &Option<String> {
        &self.alt_text
    }

    /// Sets the current alternative text value.
    pub fn set_alt_text(&mut self, alt_text: &str) {
        self.alt_text = Some(alt_text.to_string())
    }

    /// Sets the current alternative text value to `None`.
    pub fn unset_alt_text(&mut self) {
        self.alt_text = None
    }
}