pub struct HtmlGenerator { /* private fields */ }Expand description
HTML page generator.
Implementations§
Source§impl HtmlGenerator
impl HtmlGenerator
Sourcepub fn with_templates(config: Config, templates: TemplateRegistry) -> Self
pub fn with_templates(config: Config, templates: TemplateRegistry) -> Self
Create a generator with custom templates.
Sourcepub fn register_template(&mut self, template: Template)
pub fn register_template(&mut self, template: Template)
Register a custom template.
Sourcepub fn generate_page(
&self,
page: &Page,
alternates: &[(&str, &str)],
) -> Result<String>
pub fn generate_page( &self, page: &Page, alternates: &[(&str, &str)], ) -> Result<String>
Generate HTML for a page.
Sourcepub fn generate_redirect(&self, redirect_url: &str) -> Result<String>
pub fn generate_redirect(&self, redirect_url: &str) -> Result<String>
Generate redirect HTML for URL aliases.
Sourcepub fn generate_list_page(
&self,
title: &str,
items_html: &str,
pagination_html: Option<&str>,
) -> Result<String>
pub fn generate_list_page( &self, title: &str, items_html: &str, pagination_html: Option<&str>, ) -> Result<String>
Generate a list page HTML.
Sourcepub fn generate_taxonomy_page(
&self,
taxonomy_name: &str,
term: &str,
items_html: &str,
pagination_html: Option<&str>,
) -> Result<String>
pub fn generate_taxonomy_page( &self, taxonomy_name: &str, term: &str, items_html: &str, pagination_html: Option<&str>, ) -> Result<String>
Generate a taxonomy term page HTML.
Sourcepub fn output_path(&self, page: &Page, output_dir: &Path) -> PathBuf
pub fn output_path(&self, page: &Page, output_dir: &Path) -> PathBuf
Get the output path for a page.
Generate a tags index page listing all tags with their counts.
Sourcepub fn generate_categories_index_page(
&self,
categories: &HashMap<String, Vec<String>>,
lang: &str,
) -> Result<String>
pub fn generate_categories_index_page( &self, categories: &HashMap<String, Vec<String>>, lang: &str, ) -> Result<String>
Generate a categories index page listing all categories with their counts.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for HtmlGenerator
impl RefUnwindSafe for HtmlGenerator
impl Send for HtmlGenerator
impl Sync for HtmlGenerator
impl Unpin for HtmlGenerator
impl UnwindSafe for HtmlGenerator
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more