Struct LineOffset

pub struct LineOffset {
    pub line_start: usize,
    pub line_end: usize,
    pub first_nonspace: usize,
    pub indent_nonspace: i32,
}

Holds start/end/etc. positions for a specific source text line.

Fields

line_start: usize

line_start is the actual start of the line.

"  >  blockquote\r\n"
 ^-- it will always point here (must not be modified by rules)

line_end: usize

line_end is first newline character after the line, or position after string length if there aren’t any newlines left.

"  >  blockquote\r\n"
                ^-- it will point here

first_nonspace: usize

first_nonspace is the byte offset of the first non-space character in the current line.

"   >  blockquote\r\n"
       ^-- it will point here when paragraph is parsed
    ^----- it is initially pointed here

It will be modified by rules (list and blockquote), chars before it must be treated as whitespaces.

indent_nonspace: i32

indent_nonspace is the indent (amount of virtual spaces from start) of first non-space character in the current line, taking into account tab expansion.

For example, in case of \t foo, indent is 5 (tab ends at multiple of 4, then one space after it). Only tabs and spaces are counted for it, so no funny unicode business (if cmark supported unicode spaces, they’d be counted as 1 each regardless of utf8 width).

You should compare indent_nonspace with state.blkindent when determining real indent after taking into account lists.

Most block rules in commonmark are indented 0..=3, and >=4 is code block. Special value of ident_nonspace=-1 is used by this library as a sign that this rule can only be a paragraph continuation (used in blockquotes), so you must take into account that any math can end up negative.

Trait Implementations

impl Clone for LineOffset

fn clone(&self) -> LineOffset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineOffset

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

Formats the value using the given formatter.