cmark-writer 0.9.0

A CommonMark writer implementation in Rust for serializing AST nodes to CommonMark format
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

use crate::error::WriteResult;
use ecow::EcoString;

/// Formatting policy centralising newline and blank-line handling for CommonMark emission.
#[derive(Debug, Default, Clone, Copy)]
pub(crate) struct FormatPolicy;

impl FormatPolicy {
    /// Ensure the buffer ends with a single trailing newline.
    pub fn ensure_trailing_newline(&mut self, buffer: &mut EcoString) -> WriteResult<()> {
        if !buffer.ends_with('\n') {
            buffer.push('\n');
        }
        Ok(())
    }

    /// Ensure the buffer ends with an empty line (two trailing newlines).
    pub fn ensure_blank_line(&mut self, buffer: &mut EcoString) -> WriteResult<()> {
        self.ensure_trailing_newline(buffer)?;
        if trailing_newline_count(buffer) < 2 {
            buffer.push('\n');
        }
        Ok(())
    }

    /// Apply spacing rules between consecutive nodes when traversing a block sequence.
    pub fn prepare_block_sequence(
        &mut self,
        buffer: &mut EcoString,
        previous_was_block: bool,
        next_is_block: bool,
    ) -> WriteResult<()> {
        if previous_was_block && next_is_block {
            self.ensure_blank_line(buffer)
        } else if previous_was_block || next_is_block {
            self.ensure_trailing_newline(buffer)
        } else {
            Ok(())
        }
    }
}

fn trailing_newline_count(buffer: &EcoString) -> usize {
    buffer.chars().rev().take_while(|&ch| ch == '\n').count()
}