Struct FencedCodeBlockInfo 

pub struct FencedCodeBlockInfo {
    pub start_line: usize,
    pub end_line: usize,
    pub content_start: usize,
    pub content_end: usize,
    pub language: String,
    pub info_string: String,
    pub fence_char: char,
    pub fence_length: usize,
    pub content_prefix: String,
    pub code: String,
    pub line_prefix_widths: Vec<usize>,
}

Information about a fenced code block for processing.

Fields

start_line: usize

0-indexed line number where opening fence starts.

end_line: usize

0-indexed line number of the block’s last line: its closing fence, or its last code line when the block is unterminated.

content_start: usize

Byte offset where the source of the code starts (the first content line, container prefix included).

content_end: usize

Byte offset where the source of the code ends: after the line ending of its last line, or at the end of the document for an unterminated last line.

language: String

Language tag extracted from info string (first token).

info_string: String

Full info string from the fence.

fence_char: char

The fence character used (` or ~).

fence_length: usize

Length of the fence (3 or more).

content_prefix: String

What precedes every content line for the containers the block sits in: blockquote markers, list continuation indent and the fence’s own indent. Formatted code is written back behind it.

code: String

The code as CommonMark reads it, with every container prefix removed. This is what a tool receives.

line_prefix_widths: Vec<usize>

Width in characters of the source prefix removed from each line of code, so a tool’s column can be placed in the document.

Implementations

impl FencedCodeBlockInfo

pub fn source_for(&self, code: &str) -> String

The source that replaces content_start..content_end so the block’s code becomes code, every line inside the block’s containers.

pub fn document_column(&self, line: usize, column: usize) -> Option<usize>

The document column of a 1-indexed column on 1-indexed line of the code. None for a line the code does not have.

Trait Implementations

impl Clone for FencedCodeBlockInfo

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 FencedCodeBlockInfo

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

Formats the value using the given formatter.