Struct DocumentMeta 

pub struct DocumentMeta {
    pub title: Option<String>,
    pub description: Option<String>,
    pub canonical_url: Option<String>,
    pub site_name: Option<String>,
    pub image_url: Option<String>,
    pub og_type: Option<String>,
    pub twitter_card: Option<String>,
    pub twitter_site: Option<String>,
    pub open_graph: bool,
    pub twitter: bool,
    pub structured_data: bool,
}

Optional document metadata supplied by the host for one render call.

The renderer remains a pure function of the opcode stream plus this value: nothing is retained across calls. Title/description set here are fallbacks; META::SET_WINDOW_METADATA values win.

Fields

title: Option<String>

Fallback title when the stream does not set WINDOW_METADATA::TITLE.

description: Option<String>

Fallback description when the stream does not set WINDOW_METADATA::DESCRIPTION.

canonical_url: Option<String>

Absolute canonical URL for the current view.

site_name: Option<String>

og:site_name.

image_url: Option<String>

og:image / twitter:image; when absent the first IMAGE source in the tree is used.

og_type: Option<String>

og:type (default website).

twitter_card: Option<String>

twitter:card (default summary, or summary_large_image when an image is available).

twitter_site: Option<String>

twitter:site (e.g. @pathland).

open_graph: bool

Emit Open Graph tags.

twitter: bool

Emit Twitter card tags.

structured_data: bool

Emit JSON-LD structured data (WebPage + Article).

Implementations

impl DocumentMeta

pub fn new() -> Self

No extra metadata — the legacy document head.

pub fn none() -> Self

No extra metadata — the legacy document head.

pub fn seo(canonical_url: impl Into<String>) -> Self

Full SEO head for canonical_url: canonical + Open Graph + Twitter + structured data. Refine with the other builders/fields.

pub fn with_title(self, title: impl Into<String>) -> Self

Set a fallback title.

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

Set a fallback description.

pub fn with_canonical_url(self, canonical_url: impl Into<String>) -> Self

Set the canonical URL.

pub fn with_site_name(self, site_name: impl Into<String>) -> Self

Set og:site_name.

pub fn with_image_url(self, image_url: impl Into<String>) -> Self

Set og:image / twitter:image.

pub fn with_og_type(self, og_type: impl Into<String>) -> Self

Set og:type.

pub fn with_twitter_card(self, twitter_card: impl Into<String>) -> Self

Set twitter:card.

pub fn with_twitter_site(self, twitter_site: impl Into<String>) -> Self

Set twitter:site.

pub fn with_open_graph(self, on: bool) -> Self

Enable/disable Open Graph tags.

pub fn with_twitter(self, on: bool) -> Self

Enable/disable Twitter card tags.

pub fn with_structured_data(self, on: bool) -> Self

Enable/disable JSON-LD structured data.

Trait Implementations

impl Clone for DocumentMeta

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 DocumentMeta

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

Formats the value using the given formatter.

impl Default for DocumentMeta

fn default() -> Self

Returns the “default value” for a type.

impl Eq for DocumentMeta

impl PartialEq for DocumentMeta

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocumentMeta