Struct NormalizedLineEndingMap 

pub struct NormalizedLineEndingMap { /* private fields */ }

Maps byte offsets in LF-normalized content back to the original input.

rumdl normalizes CRLF to LF while linting. Machine-readable fixes, however, must address the bytes supplied by the caller, including mixed-line-ending input. Each entry records the normalized offset of a newline whose preceding carriage return was removed.

Implementations

impl NormalizedLineEndingMap

pub fn new(original: &str) -> Self

pub fn original_text_at<'a>( &self, text: &'a str, normalized_offset: usize, ) -> Cow<'a, str>

Text to insert into the original input at normalized_offset: LF-normalized text with the line ending fmt would give it there. That is the file’s own ending, or in a file with mixed endings the ending of the line the insertion follows.

pub fn restore_fixed<'a>( &self, normalized_original: &str, fixed: &'a str, ) -> Cow<'a, str>

Write fixed, the LF-normalized content after fixes, back in the line endings of the original this map was built from. normalized_original is the LF-normalized original the fixes started from.

A file with one line ending gets it throughout. In a file with mixed endings, a diff of the two texts decides each line ending: a newline the fixes kept keeps its original ending, and a newline they inserted takes the ending of the line it was inserted into, the same ending Self::original_text_at gives a JSON fix inserting it there. A line diff finds the changed regions and a byte diff aligns the newlines inside each one, so the cost follows the size of the edits.

pub fn original_offset(&self, normalized_offset: usize) -> usize

Convert a byte boundary in normalized content to the corresponding byte boundary in the original input.

pub fn restore(&self, normalized: &str) -> String

The original input, rebuilt from the LF-normalized content this map was built from by putting back each carriage return normalization removed. Exact for any input, mixed line endings included, where re-normalizing to the detected line ending is not.

Trait Implementations

impl Clone for NormalizedLineEndingMap

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 NormalizedLineEndingMap

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

Formats the value using the given formatter.

impl Default for NormalizedLineEndingMap

fn default() -> Self

Returns the “default value” for a type.

impl Eq for NormalizedLineEndingMap

impl PartialEq for NormalizedLineEndingMap

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for NormalizedLineEndingMap