Struct Pages 

pub struct Pages<S = ()> { /* private fields */ }

The pages a site serves.

Implementations

impl<S> Pages<S>

where S: Clone + Send + Sync + 'static,

pub fn new() -> Self

An empty declaration.

pub fn static_page<A>(self, page: PageTemplateData, data: A) -> Self

where A: Serialize,

A page with no logic: no handler function exists.

Its route comes from the page’s own page_url, and data is serialized once at boot. Anything that varies per request needs Pages::dynamic_page.

Panics

If data cannot be serialized.

pub fn dynamic_page( self, path: impl Into<String>, handler: MethodRouter<WebServerState<S>>, ) -> Self

A page backed by an ordinary axum handler. For a parameterised path use Pages::dynamic_page_group.

pub fn dynamic_page_group<I>( self, path: impl Into<String>, handler: MethodRouter<WebServerState<S>>, urls: I, ) -> Self

where I: IntoIterator<Item = SitemapUrl>,

One handler serving many URLs, with those URLs supplied for the sitemap.

The list is built where the route is declared, so adding a blog post cannot leave the sitemap behind.

pub fn unlisted(self) -> Self

Keeps the most recently declared page out of the sitemap.

pub fn with_last_modified(self, last_modified: DateTime<Utc>) -> Self

Sets <lastmod> on the most recently declared page.

pub fn extend_images<I, T>(self, images: I) -> Self

where I: IntoIterator<Item = T>, T: Into<String>,

Adds <image:image> entries to the most recently declared page.

pub fn paths(&self) -> Vec<&str>

Every route path that was declared, listed or not.

Used to prove the feed advertises a page the site actually serves; an unlisted page still counts, because it is still routed.

pub fn len(&self) -> usize

How many pages were declared.

pub fn is_empty(&self) -> bool

Whether nothing was declared.

pub fn declared_assets(&self) -> Vec<String>

Every URL that belongs in the sitemap.

Errors

WebServerError::DynamicPagePathHasParameters if a listed page’s path contains a route parameter, which cannot be resolved to one URL. Every asset path the declared pages reference.

Static pages only: a dynamic page builds its PageTemplateData per request, so there is nothing to inspect at boot.

pub fn sitemap_urls(&self) -> Result<Vec<SitemapUrl>, WebServerError>

Every listed page as a sitemap entry.

Errors

WebServerError::DynamicPagePathHasParameters if a listed page’s path contains a route parameter, which cannot become a single sitemap URL.

Trait Implementations

impl<S: Default> Default for Pages<S>

fn default() -> Self

Returns the “default value” for a type.