pub trait RendererModule {
// Required method
fn id(&self) -> &'static str;
// Provided methods
fn init(&mut self, site_tree: &mut SiteTree) -> Result<(), LssgError> { ... }
fn after_init(&mut self, site_tree: &SiteTree) -> Result<(), LssgError> { ... }
fn render_page<'n>(
&mut self,
dom: &mut DomTree,
context: &RenderContext<'n>,
) { ... }
fn render_body<'n>(
&mut self,
dom: &mut DomTree,
context: &RenderContext<'n>,
parent_id: DomId,
token: &Token,
tr: &mut TokenRenderer,
) -> bool { ... }
fn after_render<'n>(
&mut self,
dom: &mut DomTree,
context: &RenderContext<'n>,
) { ... }
fn options_with_default<D: Overwrite + Default>(
&self,
page: &Page,
default: D,
) -> D
where Self: Sized { ... }
fn options<D: Overwrite + Default>(&self, page: &Page) -> D
where Self: Sized { ... }
}Required Methods§
Provided Methods§
Sourcefn init(&mut self, site_tree: &mut SiteTree) -> Result<(), LssgError>
fn init(&mut self, site_tree: &mut SiteTree) -> Result<(), LssgError>
This gets run once just after site_tree has been created
Sourcefn after_init(&mut self, site_tree: &SiteTree) -> Result<(), LssgError>
fn after_init(&mut self, site_tree: &SiteTree) -> Result<(), LssgError>
Gets run after all changes to site tree has been made
Sourcefn render_page<'n>(&mut self, dom: &mut DomTree, context: &RenderContext<'n>)
fn render_page<'n>(&mut self, dom: &mut DomTree, context: &RenderContext<'n>)
Modify DomTree before rendering page
Sourcefn render_body<'n>(
&mut self,
dom: &mut DomTree,
context: &RenderContext<'n>,
parent_id: DomId,
token: &Token,
tr: &mut TokenRenderer,
) -> bool
fn render_body<'n>( &mut self, dom: &mut DomTree, context: &RenderContext<'n>, parent_id: DomId, token: &Token, tr: &mut TokenRenderer, ) -> bool
Render a token before default token renderer returns true if it parsed this token otherwise false
Sourcefn after_render<'n>(&mut self, dom: &mut DomTree, context: &RenderContext<'n>)
fn after_render<'n>(&mut self, dom: &mut DomTree, context: &RenderContext<'n>)
Gets called after body has been rendered, can be used for final changes to the dom