Skip to main content

MdxBodyEmitter

Struct MdxBodyEmitter 

Source
pub struct MdxBodyEmitter { /* private fields */ }
Expand description

Builds an MDX-runtime body - a _createMdxContent(props) function whose return value is a React tree of jsx, jsxs, and Fragment. Imports + exports hoist into a prelude; frontmatter is dropped.

Output shape follows @mdx-js/mdx’s function-body format:

  • Fragment/jsx/jsxs destructured from arguments[0] inside the fn
  • const _components = { tag: "tag", ..., ...props.components } merging default tag strings with consumer overrides; only intrinsics actually referenced get a default entry
  • capitalized JSX names destructured off _components and pre-validated with _missingMdxReference so missing components throw at render time
  • jsx for zero/one child, jsxs for multiple

Implementations§

Source§

impl MdxBodyEmitter

Source

pub fn new() -> Self

Source

pub fn render(doc: &Document) -> (String, DiagnosticEngine<Code>)

Drive the walker; return (body, diag).

Source

pub fn into_parts(self) -> (String, DiagnosticEngine<Code>)

Take both buffers: rendered MDX body and per-emitter diagnostics.

Source

pub fn into_string(self) -> String

Trait Implementations§

Source§

impl Debug for MdxBodyEmitter

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for MdxBodyEmitter

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl NodeSink for MdxBodyEmitter

Source§

fn enter(&mut self, node: &Node, _ctx: &WalkCtx<'_>)

Source§

fn leave(&mut self, node: &Node, _ctx: &WalkCtx<'_>)

Auto Trait Implementations§

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, 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, 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.