Struct sqruff_lib::core::rules::base::LintFix

pub struct LintFix {
    pub edit_type: EditType,
    pub anchor: Box<dyn Segment>,
    pub edit: Option<Vec<Box<dyn Segment>>>,
    pub source: Vec<Box<dyn Segment>>,
}

A class to hold a potential fix to a linting violation.

Args:
    edit_type (:obj:`str`): One of `create_before`, `create_after`,
        `replace`, `delete` to indicate the kind of fix this represents.
    anchor (:obj:`BaseSegment`): A segment which represents
        the *position* that this fix should be applied at. For deletions
        it represents the segment to delete, for creations it implies

the position to create at (with the existing element at this position to be moved after the edit), for a replace it implies the segment to be replaced. edit (iterable of :obj:BaseSegment, optional): For replace and create fixes, this holds the iterable of segments to create or replace at the given anchor point. source (iterable of :obj:BaseSegment, optional): For replace and create fixes, this holds iterable of segments that provided code. IMPORTANT: The linter uses this to prevent copying material from templated areas.

Fields

edit_type: EditType

anchor: Box<dyn Segment>

edit: Option<Vec<Box<dyn Segment>>>

source: Vec<Box<dyn Segment>>

Implementations

impl LintFix

pub fn create_before( anchor: Box<dyn Segment>, edit_segments: Vec<Box<dyn Segment>> ) -> Self

pub fn create_after( anchor: Box<dyn Segment>, edit_segments: Vec<Box<dyn Segment>>, source: Option<Vec<Box<dyn Segment>>> ) -> Self

pub fn replace( anchor_segment: Box<dyn Segment>, edit_segments: Vec<Box<dyn Segment>>, source: Option<Vec<Box<dyn Segment>>> ) -> Self

pub fn delete(anchor_segment: Box<dyn Segment>) -> Self

pub fn is_just_source_edit(&self) -> bool

Return whether this a valid source only edit.

Trait Implementations

impl Clone for LintFix

fn clone(&self) -> LintFix

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LintFix

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

Formats the value using the given formatter.

impl PartialEq for LintFix

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

This method tests for self and other values to be equal, and is used by ==.

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

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