Struct SourceMap 

pub struct SourceMap {
    pub pieces: Vec<SourcePiece>,
}

The pieces of a concatenated script, in the order they were joined.

Fields

pieces: Vec<SourcePiece>

Every piece, ascending by SourcePiece::at.

Implementations

impl SourceMap

pub fn whole(file: impl Into<String>) -> Self

A map of a text read whole from file.

pub fn is_empty(&self) -> bool

Whether the map names no piece.

pub fn append( &mut self, text: &mut String, body: &str, file: &str, first_line: u32, )

Append body, which starts on line first_line of file, to text, separated from what text already holds by a newline, and record where it landed.

pub fn append_mapped(&mut self, text: &mut String, body: &str, map: &SourceMap)

Append the text body that map describes to text, the way Self::append appends one piece, keeping each of its pieces.

pub fn name_unnamed(&mut self, file: &str)

Give every piece recorded without a file the name file.

pub fn place_in(&mut self, text: &str, written: &str)

Count each piece’s first line in written, the markup as the author wrote it, where the piece’s text is found there as the body of an element. text is the concatenation this map describes.

A parse sees markup with its <include> files spliced in, which shifts every line after an include; the author’s file does not have them. A piece whose text the file does not hold (one an include brought in) keeps the line it was recorded with.

pub fn locate(&self, line: u32) -> Option<(&str, u32)>

The file and the line in it that line line of the concatenated text was read from. None when the map names no piece that early.

Trait Implementations

impl Clone for SourceMap

fn clone(&self) -> SourceMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SourceMap

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

Formats the value using the given formatter.

impl Default for SourceMap

fn default() -> SourceMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SourceMap

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SourceMap

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SourceMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SourceMap

impl StructuralPartialEq for SourceMap