sitemap-xml-writer 0.1.0

A Rust library for writing sitemap.xml
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

# sitemaps

The sitemap-xml-writer crate provides writers for [`sitemap.xml`](https://www.sitemaps.org/).

[![crates.io](https://img.shields.io/crates/v/sitemap-xml-writer)](https://docs.rs/crate/sitemap-xml-writer)
[![docs.rs](https://img.shields.io/docsrs/sitemap-xml-writer)](https://docs.rs/crate/sitemap-xml-writer)

## Feature flags

- `"chrono"` ... `chrono::NaiveDate` and `chrono::DateTime` support
- `"time"` ... `time::Date` and `time::OffsetDateTime` support
- `"url"` ... `url::Url` support

## Usage

### Writing sitemap file

```rust
use sitemap_xml_writer::{SitemapWriter, Url};
use std::io::Cursor;

let mut writer = SitemapWriter::start(Cursor::new(Vec::new()))?;
writer.write(
    Url::loc("http://www.example.com/")?
        .lastmod("2005-01-01")?
        .changefreq("monthly")?
        .priority("0.8")?,
)?;
writer.end()?;

let actual = String::from_utf8(writer.into_inner().into_inner())?;
let expected = concat!(
    r#"<?xml version="1.0" encoding="UTF-8"?>"#,
    r#"<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">"#,
    r#"<url>"#,
    r#"<loc>http://www.example.com/</loc>"#,
    r#"<lastmod>2005-01-01</lastmod>"#,
    r#"<changefreq>monthly</changefreq>"#,
    r#"<priority>0.8</priority>"#,
    r#"</url>"#,
    r#"</urlset>"#
);
assert_eq!(actual, expected);
```

### Writing sitemap index file

```rust
use sitemap_xml_writer::{SitemapIndexWriter};
use std::io::Cursor;

let mut writer = SitemapIndexWriter::start(Cursor::new(Vec::new()))?;
writer.write(
    Sitemap::loc("http://www.example.com/sitemap1.xml.gz")?
        .lastmod("2004-10-01T18:23:17+00:00")?,
)?;
writer.end()?;

let actual = String::from_utf8(writer.into_inner().into_inner())?;
let expected = concat!(
    r#"<?xml version="1.0" encoding="UTF-8"?>"#,
    r#"<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">"#,
    r#"<sitemap>"#,
    r#"<loc>http://www.example.com/sitemap1.xml.gz</loc>"#,
    r#"<lastmod>2004-10-01T18:23:17+00:00</lastmod>"#,
    r#"</sitemap>"#,
    r#"</sitemapindex>"#
);
assert_eq!(actual, expected);
```