Struct doc_chunks::markdown::PlainOverlay

pub struct PlainOverlay<'a> { /* private fields */ }

A plain representation of cmark riddled chunk.

Implementations

impl<'a> PlainOverlay<'a>

pub fn extract_plain_with_mapping( cmark: &str, ignores: &Ignores ) -> (String, IndexMap<Range, SourceRange>)

Ranges are mapped cmark reduced/plain -> raw.

pub fn erase_cmark(chunk: &'a CheckableChunk, ignores: &Ignores) -> Self

Create a common mark overlay based on the provided CheckableChunk reference.

pub fn find_spans(&self, condensed_range: Range) -> IndexMap<Range, Span>

Since most checkers will operate on the plain data, an indirection to map cmark reduced / plain back to raw ranges, which are then mapped back to Spans. The returned key Ranges are in the condensed domain.

pub fn as_str(&self) -> &str

Obtains a reference to the plain, cmark erased representation.

Trait Implementations

impl<'a> Clone for PlainOverlay<'a>

fn clone(&self) -> PlainOverlay<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for PlainOverlay<'a>

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

Formats the value using the given formatter.

impl<'a> Display for PlainOverlay<'a>

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

Formats the value using the given formatter.