Struct ListingConfig 

pub struct ListingConfig {
    pub name: String,
    pub title: Option<String>,
    pub per_page: Option<usize>,
    pub tag: Option<String>,
    pub category: Option<String>,
    pub topic: Option<String>,
    pub language: Option<String>,
    pub after: Option<String>,
    pub before: Option<String>,
    pub by_year: bool,
}

One named listing.

Fields

name: String

URL segment and directory name: archive → /archive/.

title: Option<String>

Heading for the listing. Defaults to name when absent.

per_page: Option<usize>

Items per page. Zero or absent means the plugin default.

tag: Option<String>

Only pages carrying this tag.

category: Option<String>

Only pages carrying this category.

topic: Option<String>

Only pages carrying this topic.

language: Option<String>

Only pages in this language.

after: Option<String>

Only pages dated on or after this (YYYY-MM-DD).

before: Option<String>

Only pages dated on or before this (YYYY-MM-DD).

by_year: bool

Also emit /{name}/{year}/ for each year present.

Implementations

impl ListingConfig

pub fn display_title(&self) -> &str

The heading to render, falling back to the name.

pub const fn is_unfiltered(&self) -> bool

Whether this listing filters at all.

A listing with no filters is every dated page. That is legitimate — it is how you give /page/N/ a name — but it is worth being able to say so.

Trait Implementations

impl Clone for ListingConfig

fn clone(&self) -> ListingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListingConfig

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

Formats the value using the given formatter.

impl Default for ListingConfig

fn default() -> ListingConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ListingConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ListingConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.