mdbook-utils 0.1.3

Tools to manage links, reference definitions, and code examples in Markdown files, especially `mdbook` source directories.
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

//! Write links to sitemap.xml
//!
//! Inspired by <https://github.com/rxdn/mdbook-sitemap-generator/tree/master>
//! Consider using <https://docs.rs/sitewriter/1.0.4/sitewriter/>.
//! or <https://crates.io/crates/sitemap> instead.

use std::io::Write;

use anyhow::Context;
use anyhow::Error;
use anyhow::Result;
use quick_xml::events::BytesText;
use quick_xml::writer::Writer;

// Write in the sitemap.xml format to a file, given a list of links.
pub(super) fn write_xml<W: Write>(links: Vec<String>, w: &mut W) -> Result<()> {
    let mut writer = Writer::new_with_indent(w, b' ', 2);

    writer
        .write_bom()
        .context("[write_xml] Failed to write byte-order-marks to the XML document.")?;
    // Insert <?xml version="1.0" encoding="UTF-8"?>
    writer
        .get_mut()
        .write_all(b"<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n")
        .context("[write_xml] Failed to write to the XML document.")?;
    // <urlset>
    writer
        .create_element("urlset")
        .with_attribute(("xmlns", "http://www.sitemaps.org/schemas/sitemap/0.9"))
        .write_inner_content(|writer| {
            for link in links.iter() {
                // <url><loc>
                writer
                    .create_element("url")
                    .write_inner_content(|w| {
                        w.create_element("loc")
                            .write_text_content(BytesText::new(link.as_str()))
                            .context(
                                "[write_xml] Failed to write <loc> element to the XML document.",
                            )?;
                        Ok::<_, Error>(())
                    })
                    .context("[write_xml] Failed to write <url> element to the XML document.")?;
            }
            Ok::<_, Error>(())
        })?;
    Ok::<_, Error>(())
}

#[cfg(test)]
mod test {
    // use super::*;

    // #[test]
    // fn test() {
    // }
}