Struct PositionMarker

pub struct PositionMarker {
    pub source_slice: Range<usize>,
    pub templated_slice: Range<usize>,
    pub templated_file: TemplatedFile,
    pub working_line_no: usize,
    pub working_line_pos: usize,
}

A reference to a position in a file.

Things to note:

• This combines the previous functionality of FilePositionMarker and EnrichedFilePositionMarker. Additionally it contains a reference to the original templated file.
• It no longer explicitly stores a line number or line position in the source or template. This is extrapolated from the templated file as required.
• Positions in the source and template are with slices and therefore identify ranges.
• Positions within the fixed file are identified with a line number and line position, which identify a point.
• Arithmetic comparisons are on the location in the fixed file.

Fields

source_slice: Range<usize>

templated_slice: Range<usize>

templated_file: TemplatedFile

working_line_no: usize

working_line_pos: usize

Implementations

impl PositionMarker

pub fn new( source_slice: Range<usize>, templated_slice: Range<usize>, templated_file: TemplatedFile, working_line_no: Option<usize>, working_line_pos: Option<usize>, ) -> Self

creates a PositionMarker

Unlike the Python version, post_init is embedded into the new function.

pub fn source_str(&self) -> &str

pub fn line_no(&self) -> usize

pub fn line_pos(&self) -> usize

pub fn from_child_markers<'a>( markers: impl Iterator<Item = &'a PositionMarker>, ) -> PositionMarker

pub fn source_position(&self) -> (usize, usize)

Return the line and position of this marker in the source.

pub fn templated_position(&self) -> (usize, usize)

Return the line and position of this marker in the source.

pub fn working_loc_after(&self, raw: &str) -> (usize, usize)

pub fn infer_next_position( raw: &str, line_no: usize, line_pos: usize, ) -> (usize, usize)

Using the raw string provided to infer the position of the next. Line position in 1-indexed.

pub fn working_loc(&self) -> (usize, usize)

Location tuple for the working position.

pub fn from_point( source_point: usize, templated_point: usize, templated_file: TemplatedFile, working_line_no: Option<usize>, working_line_pos: Option<usize>, ) -> Self

Convenience method for creating point markers.

pub fn start_point_marker(&self) -> PositionMarker

Get a point marker from the start.

pub fn end_point_marker(&self) -> PositionMarker

pub fn is_literal(&self) -> bool

Infer literalness from context.

is_literal should return True if a fix can be applied across this area in the templated file while being confident that the fix is still appropriate in the source file. This obviously applies to any slices which are the same in the source and the templated files. Slices which are zero-length in the source are also SyntaxKind::Literal because they can’t be “broken” by any fixes, because they don’t exist in the source. This includes meta segments and any segments added during the fixing process.

This value is used for: - Ignoring linting errors in templated sections. - Whether iter_patches can return without recursing. - Whether certain rules (such as JJ01) are triggered.

pub fn from_points( start_point_marker: &PositionMarker, end_point_marker: &PositionMarker, ) -> PositionMarker

Trait Implementations

impl Clone for PositionMarker

fn clone(&self) -> PositionMarker

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PositionMarker

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

Formats the value using the given formatter.

impl Default for PositionMarker

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PositionMarker

fn eq(&self, other: &Self) -> 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 PartialOrd for PositionMarker

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for PositionMarker