Struct BaseTemplateData 

pub struct BaseTemplateData { /* private fields */ }

Per-server template data.

Built once at boot and held in the server’s state. Everything on it can be overridden for a single page by PageTemplateData, except the fields that identify the site itself.

Implementations

impl BaseTemplateData

pub fn new(params: BaseTemplateDataParams) -> Self

Builds base data with every field supplied.

Two paths are normalised on the way in. A trailing slash on base_url is stripped, so joining it with a page URL cannot produce https://example.com//blog. A leading slash on social_image is stripped, so it keys into the cache-buster map exactly like the stylesheet and script paths beside it — without that, the social card is the one asset on the site that can never be content-hashed.

pub fn with_author(self, author: impl Into<String>) -> Self

Overrides the author.

pub fn with_twitter_username(self, twitter_username: impl Into<String>) -> Self

Overrides the Twitter/X handle.

pub fn with_site_entity(self, site_entity: SiteEntity) -> Self

Overrides who or what the site represents.

pub fn with_language_code(self, language_code: impl Into<String>) -> Self

Overrides the language subtag.

pub fn with_country_code(self, country_code: impl Into<String>) -> Self

Overrides the region subtag.

pub fn replace_see_also<I, S>(self, see_also: I) -> Self

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

Replaces the og:see_also list wholesale.

For a project that should not carry the author’s personal links at all.

pub fn extend_see_also<I, S>(self, see_also: I) -> Self

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

Appends to the og:see_also list.

For a project with its own presence alongside the author’s — a band’s YouTube channel next to a personal one.

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

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

Appends to the site-wide stylesheet list.

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

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

Appends to the site-wide script list.

pub fn project(&self) -> &str

The site’s name.

pub fn description(&self) -> &str

The default description.

pub fn author(&self) -> &str

The author.

pub fn base_url(&self) -> &str

The site origin, with no trailing slash.

pub fn twitter_username(&self) -> &str

The Twitter/X handle.

pub fn social_image(&self) -> &str

The default social image.

pub fn social_image_alt(&self) -> &str

The default social image alt text.

pub const fn theme_color(&self) -> &ThemeColor

The browser-chrome colour and supported schemes.

pub const fn site_entity(&self) -> &SiteEntity

Who or what the site represents.

pub const fn theme_script(&self) -> ThemeScript

The pre-paint theme script this site’s design implies.

pub fn language_code(&self) -> &str

The language subtag.

pub fn country_code(&self) -> &str

The region subtag.

pub fn see_also(&self) -> &[String]

The og:see_also list.

pub fn copyright_start(&self) -> &str

The first year of the copyright range.

pub fn style_sheets(&self) -> &[String]

The site-wide stylesheets.

pub fn scripts(&self) -> &[String]

The site-wide scripts.

impl BaseTemplateData

pub fn goddtriffin(params: GoddtriffinParams) -> Self

Base data pre-filled with Todd Everett Griffin’s defaults.

Fills in author, language, region, Twitter/X handle, GODDTRIFFIN_SEE_ALSO and a Person site entity, and derives social_image_alt as "{project}: {description}". Everything else is required, because it differs per project.

A project that is not him — a band, a business — should call with_site_entity with an Organization, because the entity node is a factual claim search engines reconcile against.

To change what the preset filled in, call replace_see_also, extend_see_also, or one of the with_* methods on the returned value.

Trait Implementations

impl Clone for BaseTemplateData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BaseTemplateData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BaseTemplateData

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for BaseTemplateData

impl PartialEq for BaseTemplateData

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for BaseTemplateData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for BaseTemplateData