Struct Sitemap 

pub struct Sitemap { /* private fields */ }

/sitemap.xml: the pages search engines should crawl.

Answer it from a route (it is a response: application/xml). One sitemap holds at most 50,000 URLs (and 50 MB); split larger sites.

Examples

use ocre::seo::{Sitemap, SitemapUrl};

let mut sitemap = Sitemap::new();
sitemap.add(SitemapUrl {
    loc: "https://example.com/en/pricing".into(),
    lastmod: Some("2026-10-01".into()),
    alternates: vec![
        ("en".into(), "https://example.com/en/pricing".into()),
        ("fr".into(), "https://example.com/fr/pricing".into()),
    ],
});
let xml = sitemap.to_xml();
assert!(xml.contains("<url><loc>https://example.com/en/pricing</loc><lastmod>2026-10-01</lastmod>"));
assert!(xml.contains("<xhtml:link rel=\"alternate\" hreflang=\"fr\" href=\"https://example.com/fr/pricing\"/>"));

Implementations

impl Sitemap

pub const MAX_URLS: usize = 50_000

Most URLs in one sitemap file.

pub fn new() -> Self

An empty sitemap.

pub fn add(&mut self, url: SitemapUrl) -> &mut Self

Adds a page.

pub fn add_localized( &mut self, urls: &[(&str, &str)], lastmod: Option<&str>, ) -> &mut Self

Adds a page in every language: urls is (hreflang, absolute URL) for each locale, the first being the default (also x-default). Each version is listed, with all the others as alternates, as search engines expect.

Examples

let mut sitemap = ocre::seo::Sitemap::new();
sitemap.add_localized(&[("en", "https://ex.com/en"), ("fr", "https://ex.com/fr")], None);
let xml = sitemap.to_xml();
assert_eq!(xml.matches("<url>").count(), 2);
assert_eq!(xml.matches("hreflang=\"x-default\" href=\"https://ex.com/en\"").count(), 2);

pub fn len(&self) -> usize

The URLs added so far.

pub fn is_empty(&self) -> bool

Whether no URL was added.

pub fn to_xml(&self) -> String

The sitemap document (UTF-8 XML, values escaped).

Trait Implementations

impl Clone for Sitemap

fn clone(&self) -> Sitemap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sitemap

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

Formats the value using the given formatter.

impl Default for Sitemap

fn default() -> Sitemap

Returns the “default value” for a type.

impl Eq for Sitemap

impl IntoResponse for Sitemap

fn into_response(self) -> Response

Create a response.

impl PartialEq for Sitemap

fn eq(&self, other: &Sitemap) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Sitemap