Crates.io | sitemap-rs |
lib.rs | sitemap-rs |
version | 0.2.2 |
source | src |
created_at | 2022-09-03 00:56:24.238093 |
updated_at | 2024-09-27 05:07:08.675865 |
description | A Rust library to generate URL, Index, Image, Video, and News sitemaps. |
homepage | https://www.toddgriffin.me/ |
repository | https://github.com/goddtriffin/sitemap-rs |
max_upload_size | |
id | 657674 |
size | 116,902 |
A Rust library to generate URL, Index, Image, Video, and News sitemaps.
There are a bunch of restrictions as to what data your sitemaps can hold. This library surfaces these validation issues at struct instantiation time. Now you don't have to wait for Google Search Console or Bing Webmaster Tools to alert you of sitemap issues before you can fix data problems.
TooManyUrls
50,000
<url>
.TooMuchNews
1,000
<news: news>
.PriorityTooLow
and PriorityTooHigh
<priority>
must be between 0.0
and 1.0
(inclusive).TooManyImages
1,000
<image: image>
.TooManySitemaps
50,000
<sitemap>
.DescriptionTooLong
<description>
must be no longer than 2048
characters.DurationTooShort
and DurationTooLong
<duration>
must be between 1
and 28,800
seconds (inclusive).RatingTooLow
and RatingTooHigh
<rating>
must be between 0.0
and 5.0
(inclusive).UploaderNameTooLong
<uploader>
's <name>
must be no longer than 255
characters.TooManyTags
32
<tag>
.This library cannot parse sitemaps of any kind (yet! - pull requests welcome! See Feature Requests section below).
These examples should be exactly congruent to the examples found within the online documentation for each sitemap type.
cargo run --example generate_url_sitemap
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>http://www.example.com/</loc>
<lastmod>2005-01-01T09:10:11+00:00</lastmod>
<changefreq>monthly</changefreq>
<priority>0.8</priority>
</url>
</urlset>
cargo run --example generate_index_sitemap
<?xml version="1.0" encoding="UTF-8"?>
<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<sitemap>
<loc>http://www.example.com/sitemap1.xml.gz</loc>
<lastmod>2004-10-01T18:23:17+00:00</lastmod>
</sitemap>
<sitemap>
<loc>http://www.example.com/sitemap2.xml.gz</loc>
<lastmod>2005-01-01T00:00:00+00:00</lastmod>
</sitemap>
</sitemapindex>
cargo run --example generate_image_sitemap
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1">
<url>
<loc>http://example.com/sample1.html</loc>
<image:image>
<image:loc>http://example.com/image.jpg</image:loc>
</image:image>
<image:image>
<image:loc>http://example.com/photo.jpg</image:loc>
</image:image>
</url>
<url>
<loc>http://example.com/sample2.html</loc>
<image:image>
<image:loc>http://example.com/picture.jpg</image:loc>
</image:image>
</url>
</urlset>
cargo run --example generate_video_sitemap
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:video="http://www.google.com/schemas/sitemap-video/1.1">
<url>
<loc>http://www.example.com/videos/some_video_landing_page.html</loc>
<video:video>
<video:thumbnail_loc>http://www.example.com/thumbs/123.jpg</video:thumbnail_loc>
<video:title>Grilling steaks for summer</video:title>
<video:description>Alkis shows you how to get perfectly done steaks every time</video:description>
<video:content_loc>http://streamserver.example.com/video123.mp4</video:content_loc>
<video:player_loc>http://www.example.com/videoplayer.php?video=123</video:player_loc>
<video:duration>600</video:duration>
<video:expiration_date>2021-11-05T19:20:30+08:00</video:expiration_date>
<video:rating>4.2</video:rating>
<video:view_count>12345</video:view_count>
<video:publication_date>2007-11-05T19:20:30+08:00</video:publication_date>
<video:family_friendly>yes</video:family_friendly>
<video:restriction relationship="allow">IE GB US CA</video:restriction>
<video:platform relationship="allow">web tv</video:platform>
<video:requires_subscription>yes</video:requires_subscription>
<video:uploader info="http://www.example.com/users/grillymcgrillerson">GrillyMcGrillserson</video:uploader>
<video:live>no</video:live>
<video:tag>steak</video:tag>
<video:tag>meat</video:tag>
<video:tag>summer</video:tag>
<video:tag>outdoor</video:tag>
</video:video>
</url>
</urlset>
cargo run --example generate_news_sitemap
<?xml version="1.0" encoding="UTF-8"?>
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:news="http://www.google.com/schemas/sitemap-news/0.9">
<url>
<loc>http://www.example.org/business/article55.html</loc>
<news:news>
<news:publication>
<news:name>The Example Times</news:name>
<news:language>en</news:language>
</news:publication>
<news:publication_date>2008-12-23T09:10:11+00:00</news:publication_date>
<news:title>Companies A, B in Merger Talks</news:title>
</news:news>
</url>
</urlset>
The rust-sitemap
and sitewriter
libraries are by far the best alternatives.
This pro/con list is accurate as of the most recent update to this document.
Project is under active maintenance - even if there are no recent commits! Please submit an issue / bug request if the library needs updating for any reason!
Built with: Rust 1.65
I would love to have this library use quick-xml instead of xml-builder.
The quick-xml
library is built for speed and supports not only writing files, but reading them too.
I haven't benchmarked xml-builder
or its use in this library, so I cannot state the impact quick-xml
will have there.
I originally went with xml-builder
due to how extremely easy it is to learn and use.
It is by far fast enough for my use-cases, so I didn't have to reach for anything else.
If you like what this library provides, but simply need the ability to parse sitemaps and could also use a speed boost -
please consider pushing a pull request! (Preferably one that replaces xml-builder
with quick-xml
lol)
In video sitemaps, there is a tag called <video: restriction>
where the text is a space-delimited list of country codes
in ISO 3166 format.
Currently, the country codes are typed-hinted as merely a HashSet<String>
.
It would be awesome if there was an enum/struct that codified each ISO 3166 country code as a separate entity, so this
library could have extra assurances that each code was valid.
The isocountry-rs and rust_iso_3166 libraries looks promising.
This hasn't been prioritized yet as I am currently satisfied with HashSet<String>
for my use cases.
Pull requests are welcome!
make lint
cargo fmt
.make test
cargo fmt
cargo check
cargo clippy
(with insanely strict defaults)cargo test
.Made with 🤬 and 🥲 by Todd Everett Griffin.
sitemap-rs
is open source under the MIT License.