Struct ftml::PageInfo

pub struct PageInfo<'a> {
    pub title: &'a str,
    pub alt_title: Option<&'a str>,
    pub header: Option<&'a str>,
    pub subheader: Option<&'a str>,
    pub rating: i32,
    pub tags: Vec<&'a str>,
}

Metadata information on the article being rendered.

Fields

title: &'a str

The title of this page.

For SCPs this is "SCP-XXXX".

alt_title: Option<&'a str>

The alternate title of this page.

For SCPs this is its series listing title. If this is None then the main title is used instead.

header: Option<&'a str>

The header of this page, if it's setting one.

For regular pages this is "SCP Foundation". Previously this value was overriden using custom CSS.

subheader: Option<&'a str>

The sub-header of this page, if it's setting one.

For regular pages this is "Secure, Contain, Protect". Previously this value was overriden using custom CSS.

rating: i32

The current rating the page has.

tags: Vec<&'a str>

The current set of tags this page has.

Trait Implementations

impl<'a> Clone for PageInfo<'a>

fn clone(&self) -> PageInfo<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PageInfo<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for PageInfo<'a>

impl<'a> PartialEq<PageInfo<'a>> for PageInfo<'a>

fn eq(&self, other: &PageInfo<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &PageInfo<'a>) -> bool

This method tests for !=.

impl<'a> StructuralEq for PageInfo<'a>

impl<'a> StructuralPartialEq for PageInfo<'a>