Struct CommonMarkWriter 

pub struct CommonMarkWriter {
    pub options: WriterOptions,
    pub buffer: EcoString,
    /* private fields */
}

CommonMark writer responsible for serializing AST nodes to CommonMark text.

Fields

options: WriterOptions

Writer options.

buffer: EcoString

Buffer for storing the output text.

Implementations

impl CommonMarkWriter

pub fn new() -> Self

Create a new CommonMark writer with default options.

pub fn with_options(options: WriterOptions) -> Self

Create a new CommonMark writer with specified options.

pub fn with_diagnostic_sink( self, sink: Box<dyn DiagnosticSink + 'static>, ) -> Self

Replace the diagnostic sink used to capture non-fatal issues.

pub fn set_diagnostic_sink(&mut self, sink: Box<dyn DiagnosticSink + 'static>)

Swap the diagnostic sink on an existing writer.

pub fn diagnostic_sink(&mut self) -> &mut dyn DiagnosticSink

Get a mutable handle to the diagnostic sink.

pub fn write(&mut self, node: &Node) -> WriteResult<()>

Write an AST node as CommonMark format.

pub fn into_string(self) -> EcoString

Get the generated CommonMark format text.

pub fn write_str(&mut self, s: &str) -> WriteResult<()>

Write a string to the output buffer.

pub fn write_char(&mut self, c: char) -> WriteResult<()>

Write a character to the output buffer.

Trait Implementations

impl Debug for CommonMarkWriter

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

Formats the value using the given formatter.

impl Default for CommonMarkWriter

fn default() -> Self

Returns the “default value” for a type.

impl NodeHandler for CommonMarkWriter

type Error = WriteError

Error type produced during traversal.

fn document(&mut self, children: &[Node]) -> WriteResult<()>

fn paragraph(&mut self, content: &[Node]) -> WriteResult<()>

fn text(&mut self, text: &EcoString) -> WriteResult<()>

fn emphasis(&mut self, content: &[Node]) -> WriteResult<()>

fn strong(&mut self, content: &[Node]) -> WriteResult<()>

fn thematic_break(&mut self) -> WriteResult<()>

fn heading( &mut self, level: u8, content: &[Node], heading_type: &HeadingType, ) -> WriteResult<()>

fn inline_code(&mut self, code: &EcoString) -> WriteResult<()>

fn code_block( &mut self, language: &Option<EcoString>, content: &EcoString, block_type: &CodeBlockType, ) -> WriteResult<()>

fn html_block(&mut self, content: &EcoString) -> WriteResult<()>

fn html_element(&mut self, element: &HtmlElement) -> WriteResult<()>

fn block_quote(&mut self, content: &[Node]) -> WriteResult<()>

fn unordered_list(&mut self, items: &[ListItem]) -> WriteResult<()>

fn ordered_list(&mut self, start: u32, items: &[ListItem]) -> WriteResult<()>

fn table(&mut self, headers: &[Node], rows: &[Vec<Node>]) -> WriteResult<()>

fn link( &mut self, url: &EcoString, title: &Option<EcoString>, content: &[Node], ) -> WriteResult<()>

fn image( &mut self, url: &EcoString, title: &Option<EcoString>, alt: &[Node], ) -> WriteResult<()>

fn soft_break(&mut self) -> WriteResult<()>

fn hard_break(&mut self) -> WriteResult<()>

fn autolink(&mut self, url: &EcoString, is_email: bool) -> WriteResult<()>

fn link_reference_definition( &mut self, label: &EcoString, destination: &EcoString, title: &Option<EcoString>, ) -> WriteResult<()>

fn reference_link( &mut self, label: &EcoString, content: &[Node], ) -> WriteResult<()>

fn custom(&mut self, node: &dyn CustomNode) -> WriteResult<()>

fn unsupported(&mut self, node: &Node) -> WriteResult<()>

fn visit_node(&mut self, node: &Node) -> Result<(), Self::Error>

Dispatch a single node. Most implementers will not override this and will instead implement the per-variant methods below.

fn visit_nodes(&mut self, nodes: &[Node]) -> Result<(), Self::Error>

Visit a sequence of nodes.