Struct PageTemplateData 

pub struct PageTemplateData { /* private fields */ }

Per-render template data.

Non-generic on purpose: the data a page displays is passed alongside this to the render call rather than stored on it, so every builder method below is type-preserving.

Implementations

impl PageTemplateData

pub fn new( template: impl Into<String>, page_name: impl Into<String>, page_url: impl Into<String>, ) -> Self

Names a page.

• template is the registered Handlebars name, e.g. home.
• page_name is the human name, e.g. Blog. It becomes the <title> via the computed display_name, which is the only way to influence the title.
• page_url is this page’s path from the site root, with a leading slash, e.g. /blog. It becomes the canonical URL.

pub fn with_description(self, description: impl Into<String>) -> Self

Overrides the base description for this page.

pub fn with_social_image(self, social_image: impl Into<String>) -> Self

Overrides the base social card image for this page.

pub fn with_social_image_alt(self, social_image_alt: impl Into<String>) -> Self

Overrides the base social card alt text for this page.

pub fn with_robots(self, robots: impl Into<String>) -> Self

Overrides robots::DEFAULT for this page. See robots for the common directives.

pub fn with_jsonld(self, jsonld: Value) -> Self

Attaches a schema.org JSON-LD document.

Takes a Value rather than a pre-escaped string so the escaping cannot be skipped — a </script> inside a string value would otherwise break out of the block. @context is filled in when absent.

pub fn with_article(self, article: Article) -> Self

Marks this page as an article and attaches its metadata.

This is the only way to set og:type to article, so the type and the article:* tags can never disagree.

pub fn replace_style_sheets<I, S>(self, style_sheets: I) -> Self

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

Replaces the base stylesheet list wholesale for this page.

pub fn extend_style_sheets<I, S>(self, style_sheets: I) -> Self

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

Appends to whatever stylesheet list this page ends up with.

pub fn replace_scripts<I, S>(self, scripts: I) -> Self

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

Replaces the base script list wholesale for this page.

pub fn extend_scripts<I, S>(self, scripts: I) -> Self

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

Appends to whatever script list this page ends up with.

pub fn template(&self) -> &str

The registered Handlebars template name.

pub fn page_name(&self) -> &str

The human page name.

pub fn page_url(&self) -> &str

This page’s path from the site root.

pub fn description(&self) -> Option<&str>

This page’s description override, if any.

pub fn social_image(&self) -> Option<&str>

This page’s social image override, if any.

pub fn social_image_alt(&self) -> Option<&str>

This page’s social image alt override, if any.

pub fn robots(&self) -> &str

This page’s robots directive, defaulting to robots::DEFAULT.

pub const fn jsonld(&self) -> Option<&Value>

This page’s JSON-LD document, if any.

pub const fn article(&self) -> Option<&Article>

This page’s article metadata, if it is one.

pub const fn og_type(&self) -> &'static str

The Open Graph object type, derived from whether this page is an article.

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

Every asset path this page declares for itself.

Boot-time validation walks these so a typo in a page-specific stylesheet fails the deploy rather than silently 404ing for a visitor.

pub fn resolve_style_sheets<'a>(&'a self, base: &'a [String]) -> Vec<&'a str>

Resolves the final stylesheet list: base, optionally replaced, then extended.

pub fn resolve_scripts<'a>(&'a self, base: &'a [String]) -> Vec<&'a str>

Resolves the final script list: base, optionally replaced, then extended.

Trait Implementations

impl Clone for PageTemplateData

fn clone(&self) -> PageTemplateData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PageTemplateData

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

Formats the value using the given formatter.

impl Eq for PageTemplateData

impl PartialEq for PageTemplateData

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PageTemplateData