Struct CommonMarkWriter

pub struct CommonMarkWriter { /* private fields */ }

CommonMark writer

This struct is responsible for serializing AST nodes to CommonMark-compliant text.

Implementations

impl CommonMarkWriter

pub fn new() -> Self

Create a new CommonMark writer with default options

Example

use cmark_writer::writer::CommonMarkWriter;
use cmark_writer::ast::Node;

let mut writer = CommonMarkWriter::new();
writer.write(&Node::Text("Hello".to_string())).unwrap();
assert_eq!(writer.into_string(), "Hello");

pub fn with_options(options: WriterOptions) -> Self

Create a new CommonMark writer with specified options

Parameters

• options - Custom CommonMark formatting options

Example

use cmark_writer::writer::CommonMarkWriter;
use cmark_writer::options::WriterOptions;

let options = WriterOptions {
    strict: true,
    hard_break_spaces: false,  // Use backslash for line breaks
    indent_spaces: 2,          // Use 2 spaces for indentation
    ..Default::default()       // Other options can be set as needed
};
let writer = CommonMarkWriter::with_options(options);

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

Write an AST node as CommonMark format

Parameters

• node - The AST node to write

Returns

If writing succeeds, returns Ok(()), otherwise returns Err(WriteError)

Example

use cmark_writer::writer::CommonMarkWriter;
use cmark_writer::ast::Node;

let mut writer = CommonMarkWriter::new();
writer.write(&Node::Text("Hello".to_string())).unwrap();

pub fn into_string(self) -> String

Get the generated CommonMark format text

Consumes the writer and returns the generated string

Example

use cmark_writer::writer::CommonMarkWriter;
use cmark_writer::ast::Node;

let mut writer = CommonMarkWriter::new();
writer.write(&Node::Text("Hello".to_string())).unwrap();
let result = writer.into_string();
assert_eq!(result, "Hello");

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

Write a string to the output buffer

This method is provided for custom node implementations to use

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

Write a character to the output buffer

This method is provided for custom node implementations to use

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.