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

use crate::model::block::caption::HasCaption;
use crate::model::block::{BlockContent, Caption};
use crate::model::block::{HasLabel, Label};
use crate::model::inline::Image;
#[cfg(feature = "fmt_json")]
use serde::{Deserialize, Serialize};

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

///
/// An image block wraps an inline `Image` so that it forms a stand-alone block within the document.
///
#[derive(Clone, Debug)]
#[cfg_attr(feature = "fmt_json", derive(Serialize, Deserialize))]
pub struct ImageBlock {
    #[cfg_attr(feature = "fmt_json", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "fmt_json", serde(default))]
    label: Option<Label>,
    image: Image,
    #[cfg_attr(feature = "fmt_json", serde(skip_serializing_if = "Option::is_none"))]
    #[cfg_attr(feature = "fmt_json", serde(default))]
    caption: Option<Caption>,
}

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

impl From<String> for ImageBlock {
    fn from(target: String) -> Self {
        Self::from(Image::from(target))
    }
}

impl From<Image> for ImageBlock {
    fn from(image: Image) -> Self {
        Self {
            label: None,
            image,
            caption: None,
        }
    }
}

label_impl!(ImageBlock);

block_impls!(ImageBlock);

has_captioned_impls!(ImageBlock);

impl ImageBlock {
    /// Create a new image block from the provided `Image` instance and caption String.
    pub fn with_caption(image: Image, caption: Caption) -> Self {
        Self {
            label: None,
            image,
            caption: Some(caption),
        }
    }

    /// Create a new image block from the provided `Image` instance and caption string.
    pub fn with_caption_str(image: Image, caption: &str) -> Self {
        Self::with_caption(image, caption.into())
    }

    /// Return a reference to the inner image value.
    pub fn inner(&self) -> &Image {
        &self.image
    }
}