normano/sitemap-xml-writer

A Rust library for writing sitemap.xml

sitemap-xml-writer

A Rust library for writing sitemap.xml.

Feature flags

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

Usage

Writing sitemap file

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

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);

License

Licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.