Struct RenderContext

Source
pub struct RenderContext<'a> {
    pub doc: &'a mut Document<Ast>,
    pub templates: &'a TemplateManager,
    pub extra_args: Context,
    pub notebook_output_meta: &'a NotebookMeta,
    pub format: &'a dyn Format,
    pub parser_settings: ParserSettings,
    pub references: LinkedHashMap<String, Reference>,
    pub references_by_type: HashMap<String, Vec<(String, Reference)>>,
}
Expand description

Context that is passed to the render functions.

Fields§

§doc: &'a mut Document<Ast>

The document that is being rendered

§templates: &'a TemplateManager§extra_args: Context

Extra arguments (this type is essentially a wrapped HashMap)

§notebook_output_meta: &'a NotebookMeta

For syntax highlighting using Syntect

§format: &'a dyn Format§parser_settings: ParserSettings§references: LinkedHashMap<String, Reference>§references_by_type: HashMap<String, Vec<(String, Reference)>>

Implementations§

Source§

impl<'a> RenderContext<'a>

Source

pub fn new( doc: &'a mut Document<Ast>, templates: &'a TemplateManager, extra_args: Context, notebook_output_meta: &'a NotebookMeta, format: &'a dyn Format, parser_settings: ParserSettings, ) -> Result<Self>

Auto Trait Implementations§

§

impl<'a> Freeze for RenderContext<'a>

§

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> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, R> RenderElement<Vec<R>> for T
where T: RenderElement<R>,

Source§

fn render( &mut self, elem: &Vec<R>, ctx: &RenderContext<'_>, buf: impl Write, ) -> Result<(), Error>

Render the element to a buffer
Source§

fn render_inner(&mut self, elem: &T, ctx: &RenderContext<'_>) -> Result<CowStr>

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.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,