Struct SourceMap

pub struct SourceMap<SourceIndex, TargetIndex> { /* private fields */ }

A SourceMap provides information necessary to understand which parts of a target were derived from which parts of a source artifact, in such a way that they can be mapped in either direction.

The behavior of such mappings depends on the implementations of the generic Index types, but this may be a many-to-many mapping, where one element of the source is mapped (contributes) to zero or many elements of the target, and vice versa.

This is also intended to be mergeable in a chain, such that the combined result of a series of transformations can be expressed within a single source mapping.

Implementations

impl<SourceIndex, TargetIndex> SourceMap<SourceIndex, TargetIndex>

pub fn list_sources<QueryIndex>( &self, target_index: &QueryIndex, ) -> Vec<&SourceIndex>

where TargetIndex: SourceMapIndexable<QueryIndex>,

Return all source ranges in the source map which were used to generate the target range.

This is O(n) where n is the number of entries in the map.

pub fn list_targets<QueryIndex>( &self, source_index: &QueryIndex, ) -> Vec<&TargetIndex>

where SourceIndex: SourceMapIndexable<QueryIndex>,

Return all target ranges in the source map which were used to generate the source range.

This is O(n) where n is the number of entries in the map.

impl<SourceIndex, TargetIndex> SourceMap<SourceIndex, TargetIndex>

pub fn entries(&self) -> &[SourceMapEntry<SourceIndex, TargetIndex>]

Trait Implementations

impl<SourceIndex: Clone, TargetIndex: Clone> Clone for SourceMap<SourceIndex, TargetIndex>

fn clone(&self) -> SourceMap<SourceIndex, TargetIndex>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<SourceIndex: Debug, TargetIndex: Debug> Debug for SourceMap<SourceIndex, TargetIndex>

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

Formats the value using the given formatter.

impl<SourceIndex, TargetIndex> Default for SourceMap<SourceIndex, TargetIndex>

fn default() -> Self

Returns the “default value” for a type.

impl<SourceIndex: PartialEq, TargetIndex: PartialEq> PartialEq for SourceMap<SourceIndex, TargetIndex>

fn eq(&self, other: &SourceMap<SourceIndex, TargetIndex>) -> 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<SourceIndex, TargetIndex> StructuralPartialEq for SourceMap<SourceIndex, TargetIndex>