rustdoc_copy_macro 0.2.0

Macros for `rustdoc_copy`
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

//! Provider of [`UrlEvent`].

use pulldown_cmark::{CowStr, Event, LinkType, Tag};

/// Markdown event with URL.
pub(crate) struct UrlEvent<'a> {
    /// Link type.
    link_type: LinkType,
    /// Destination URL.
    dest_url: CowStr<'a>,
    /// Link title.
    title: CowStr<'a>,
    /// ID of reference links, e.g. world in the link `[hello][world]`.
    id: CowStr<'a>,
}

impl<'a> UrlEvent<'a> {
    /// Creates a new link event if it exists.
    pub fn try_new_link(event: &Event<'a>) -> Option<Self> {
        match event {
            Event::Start(Tag::Link {
                link_type,
                dest_url,
                title,
                id,
            }) => Some(Self {
                link_type: *link_type,
                dest_url: dest_url.clone(),
                title: title.clone(),
                id: id.clone(),
            }),
            _ => None,
        }
    }

    /// Creates a new image event if it exists.
    pub fn try_new_image(event: &Event<'a>) -> Option<Self> {
        match event {
            Event::Start(Tag::Image {
                link_type,
                dest_url,
                title,
                id,
            }) => Some(Self {
                link_type: *link_type,
                dest_url: dest_url.clone(),
                title: title.clone(),
                id: id.clone(),
            }),
            _ => None,
        }
    }

    /// Creates a new instance with given link type.
    pub fn with_link_type(self, value: LinkType) -> Self {
        Self {
            link_type: value,
            ..self
        }
    }

    /// Creates a new instance with given destination URL.
    pub fn with_dest_url(self, value: &str) -> Self {
        Self {
            dest_url: value.to_string().into(),
            ..self
        }
    }

    /// Returns link type.
    pub fn link_type(&self) -> LinkType {
        self.link_type
    }

    /// Returns destination URL.
    pub fn dest_url(&self) -> CowStr<'a> {
        self.dest_url.clone()
    }

    /// Returns link title.
    pub fn title(&self) -> CowStr<'a> {
        self.title.clone()
    }

    /// Returns ID of reference links, e.g. world in the link `[hello][world]`.
    pub fn id(&self) -> CowStr<'a> {
        self.id.clone()
    }

    /// Returns link event tag.
    pub fn to_link(&self) -> Event<'a> {
        Event::Start(Tag::Link {
            link_type: self.link_type,
            dest_url: self.dest_url.clone(),
            title: self.title.clone(),
            id: self.id.clone(),
        })
    }

    /// Returns image event tag.
    pub fn to_image(&self) -> Event<'a> {
        Event::Start(Tag::Image {
            link_type: self.link_type,
            dest_url: self.dest_url.clone(),
            title: self.title.clone(),
            id: self.id.clone(),
        })
    }
}