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

//! Provider of [`MdSplitter`].

use crate::util::md_tools::md_print::*;
use pulldown_cmark::Event;
use std::iter::Peekable;

/// Markdown splitter.
///
/// This type was introduced to handle subtle problems in Markdown reprint.
/// Broken links are printed like `\[link\]`. Here, Rustdoc API links are
/// treated in the same way because they sometimes lack a URL. Therefore,
/// the broken link must be handled separately. This type splits the
/// sequence of Markdown events for it.
pub(crate) struct MdSplitter<'a, I>
where
    I: Iterator<Item = Event<'a>>,
{
    /// Markdown events.
    events: Peekable<I>,
}

impl<'a, I> MdSplitter<'a, I>
where
    I: Iterator<Item = Event<'a>>,
{
    /// Creates an new instance.
    pub fn new(events: I) -> Self {
        Self {
            events: events.peekable(),
        }
    }
}

impl<'a, I> Iterator for MdSplitter<'a, I>
where
    I: Iterator<Item = Event<'a>>,
{
    type Item = MdPartition<'a>;

    fn next(&mut self) -> Option<Self::Item> {
        MdPartition::new(&mut self.events)
    }
}