Struct blades::Taxonomy

pub struct Taxonomy<'t, 'r> { /* fields omitted */ }

One taxonomical category of the site (e.g. tags, categories).

Implementations

impl<'t, 'r> Taxonomy<'t, 'r>

pub fn classify(
    pages: &'r [Page<'t>],
    config: &'r Config<'t>,
    templates: &'r Templates
) -> Result<HashMap<&'r str, Taxonomy<'t, 'r>, RandomState>>

Classify the given pages into taxonomies specified by the config.

pub fn keys(&self) -> &HashMap<&'r str, Vec<PageLinked<'t, 'r>>, RandomState>

Get a reference to the key map of the given taxonomy.

pub fn render(
    &self,
    config: &Config<'t>,
    classification: &HashMap<&'_ str, Taxonomy<'t, '_>, RandomState>,
    all: &[Page<'t>],
    rendered: &MutSet
) -> Result

Render this taxonomy into the output directory specified by the config.

pub fn render_key(
    &self,
    title: &str,
    pages: &[PageLinked<'t, '_>],
    config: &Config<'t>,
    classification: &HashMap<&'_ str, Taxonomy<'t, '_>, RandomState>,
    all: &[Page<'t>],
    rendered: &MutSet
) -> Result

Render one key of this taxonomy into the output directory specified by the config.

Trait Implementations

impl<'t, 'r> Content for Taxonomy<'t, 'r>

fn capacity_hint(&self, tpl: &Template<'_>) -> usize

How much capacity is likely required for all the data in this Content for a given Template.

fn render_section<C, E>(
    &self,
    section: Section<'_, C>,
    encoder: &mut E
) -> Result<(), E::Error> where
    C: ContentSequence,
    E: Encoder, 

Render a section with self.

fn render_field_escaped<E>(
    &self,
    hash: u64,
    name: &str,
    encoder: &mut E
) -> Result<bool, E::Error> where
    E: Encoder, 

Render a field by the hash or string of its name.

fn render_field_unescaped<E>(
    &self,
    hash: u64,
    name: &str,
    encoder: &mut E
) -> Result<bool, E::Error> where
    E: Encoder, 

Render a field by the hash or string of its name.

fn render_field_section<P, E>(
    &self,
    hash: u64,
    name: &str,
    section: Section<'_, P>,
    encoder: &mut E
) -> Result<bool, E::Error> where
    P: ContentSequence,
    E: Encoder, 

Render a field by the hash or string of its name, as a section. If successful, returns true if the field exists in this content, otherwise false.

fn render_field_inverse<P, E>(
    &self,
    hash: u64,
    name: &str,
    section: Section<'_, P>,
    encoder: &mut E
) -> Result<bool, E::Error> where
    P: ContentSequence,
    E: Encoder, 

Render a field, by the hash of or string its name, as an inverse section. If successful, returns true if the field exists in this content, otherwise false.

fn is_truthy(&self) -> bool

Marks whether this content is truthy. Used when attempting to render a section.

fn render_escaped<E>(
    &self,
    _encoder: &mut E
) -> Result<(), <E as Encoder>::Error> where
    E: Encoder, 

Renders self as a variable to the encoder.

fn render_unescaped<E>(
    &self,
    encoder: &mut E
) -> Result<(), <E as Encoder>::Error> where
    E: Encoder, 

Renders self as a variable to the encoder.

fn render_cmark<E>(&self, encoder: &mut E) -> Result<(), <E as Encoder>::Error> where
    E: Encoder, 

Renders self as a variable to the encoder with CommonMark processing.

fn render_inverse<C, E>(
    &self,
    section: Section<'_, C>,
    encoder: &mut E
) -> Result<(), <E as Encoder>::Error> where
    C: ContentSequence,
    E: Encoder, 

Render a section with self.