Struct MarkdownRenderer 

pub struct MarkdownRenderer { /* private fields */ }

Render an mdast tree or fragment as Markdown.

The default options produce standard Markdown. Use with_options to configure markers and other formatting choices, or try_render to handle invalid options without panicking.

Example

use socketry_markdown::{mdast::Node, renderer::MarkdownRenderer};

let node: Node = /* an mdast tree */;
let mut renderer = MarkdownRenderer::new();
let markdown = node.render_with(&mut renderer);

Implementations

impl MarkdownRenderer

pub fn new() -> Self

Create a Markdown renderer with default options.

pub fn with_options(options: Options) -> Self

Create a Markdown renderer with custom serialization options.

pub fn options(&self) -> &Options

Return the options used by this renderer.

pub fn try_render(&mut self, node: &Node) -> Result<String, Message>

Render a node, returning an error if the options are invalid.

Errors

Returns an error if an option contains an invalid marker or the AST contains a node that cannot be serialized.

Trait Implementations

impl Clone for MarkdownRenderer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MarkdownRenderer

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

Formats the value using the given formatter.

impl Default for MarkdownRenderer

fn default() -> Self

Returns the “default value” for a type.

impl Renderer for MarkdownRenderer

fn render_node(&mut self, node: &Node) -> String

Render one AST node into this renderer’s output.

fn render(&mut self, node: &Node) -> String

Render a node and its descendants.

fn render_children(&mut self, node: &Node) -> String

Render the direct children of a parent node in order.