Struct cdoc::renderers::RenderContext
source · pub struct RenderContext<'a> {
pub doc: &'a Document<Ast>,
pub templates: &'a TemplateManager,
pub extra_args: Context,
pub syntax_set: &'a SyntaxSet,
pub theme: &'a Theme,
pub notebook_output_meta: &'a NotebookMeta,
pub format: &'a dyn Format,
}Expand description
Context that is passed to the render functions.
Fields§
§doc: &'a Document<Ast>The document that is being rendered
templates: &'a TemplateManager§extra_args: ContextExtra arguments (this type is essentially a wrapped HashMap)
syntax_set: &'a SyntaxSetFor syntax highlighting using Syntect
theme: &'a Theme§notebook_output_meta: &'a NotebookMeta§format: &'a dyn FormatAuto Trait Implementations§
impl<'a> !RefUnwindSafe for RenderContext<'a>
impl<'a> Send for RenderContext<'a>
impl<'a> Sync for RenderContext<'a>
impl<'a> Unpin for RenderContext<'a>
impl<'a> !UnwindSafe for RenderContext<'a>
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, R> RenderElement<Vec<R, Global>> for Twhere
T: RenderElement<R>,
impl<T, R> RenderElement<Vec<R, Global>> for Twhere T: RenderElement<R>,
source§fn render(
&mut self,
elem: &Vec<R, Global>,
ctx: &RenderContext<'_>,
buf: impl Write
) -> Result<(), Error>
fn render( &mut self, elem: &Vec<R, Global>, ctx: &RenderContext<'_>, buf: impl Write ) -> Result<(), Error>
Render the element to a buffer
source§fn render_inner(&mut self, elem: &T, ctx: &RenderContext<'_>) -> Result<String>
fn render_inner(&mut self, elem: &T, ctx: &RenderContext<'_>) -> Result<String>
Convenience function for creating a buffer, rendering the element into the buffer, and
returning the result as a string. This is useful when an inner element needs to be rendered
first to be used in an outer element, hence the name.