Struct SitemapGenerator 

pub struct SitemapGenerator;

Renders sitemaps and sitemap indexes.

Implementations

impl SitemapGenerator

pub fn generate(urls: &[SitemapUrl]) -> String

Renders a <urlset> sitemap.

An empty list still produces a well-formed, empty <urlset>. An entry whose loc is not an absolute http:// or https:// URL is left out: the protocol requires a full URL, and a crawler or tool that lists the entries would otherwise be handed javascript:….

This does not enforce the protocol’s limit of MAX_URLS URLs and MAX_BYTES bytes per file; split a larger site with SitemapGenerator::chunks and list the parts in a generate_index.

pub fn chunks(urls: &[SitemapUrl]) -> impl Iterator<Item = &[SitemapUrl]>

Splits urls into slices that each fit in one sitemap file (at most MAX_URLS).

The byte limit depends on how long the URLs are, so check generate(chunk).len() <= MAX_BYTES and split further if a chunk is over.

Examples

use molt::sitemap::{SitemapGenerator, SitemapUrl, MAX_URLS};
let urls: Vec<SitemapUrl> = (0..=MAX_URLS)
    .map(|i| SitemapUrl::new(format!("https://example.com/{i}")))
    .collect();
assert_eq!(SitemapGenerator::chunks(&urls).count(), 2);

pub fn generate_index(sitemaps: &[(String, Option<String>)]) -> String

Renders a <sitemapindex> pointing at several sitemaps. An entry whose location is not an absolute http:// or https:// URL is left out, as in generate.

Trait Implementations

impl Clone for SitemapGenerator

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for SitemapGenerator

impl Debug for SitemapGenerator

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.