Struct sqruff_lib::core::parser::segments::base::SymbolSegment

pub struct SymbolSegment { /* private fields */ }

A segment used for matching single entities which aren’t keywords.

We rename the segment class here so that descendants of
_ProtoKeywordSegment can use the same functionality
but don't end up being labelled as a `keyword` later.

Implementations

impl SymbolSegment

pub fn create( raw: &str, position_maker: Option<PositionMarker>, args: SymbolSegmentNewArgs, ) -> ErasedSegment

Trait Implementations

impl Clone for SymbolSegment

fn clone(&self) -> SymbolSegment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolSegment

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

Formats the value using the given formatter.

impl PartialEq for SymbolSegment

fn eq(&self, other: &SymbolSegment) -> 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 Segment for SymbolSegment

fn new(&self, _segments: Vec<ErasedSegment>) -> ErasedSegment

fn raw(&self) -> Cow<'_, str>

fn get_type(&self) -> SyntaxKind

fn is_code(&self) -> bool

fn is_comment(&self) -> bool

fn is_whitespace(&self) -> bool

fn get_position_marker(&self) -> Option<PositionMarker>

fn set_position_marker(&mut self, position_marker: Option<PositionMarker>)

fn segments(&self) -> &[ErasedSegment]

fn get_raw_segments(&self) -> Vec<ErasedSegment>

Iterate raw segments, mostly for searching.

fn get_uuid(&self) -> Uuid

fn get_source_fixes(&self) -> Vec<SourceFix>

Return any source fixes as list.

fn edit( &self, raw: Option<String>, _source_fixes: Option<Vec<SourceFix>>, ) -> ErasedSegment

Stub.

fn instance_types(&self) -> SyntaxSet

fn class_types(&self) -> SyntaxSet

fn copy(&self, _segments: Vec<ErasedSegment>) -> ErasedSegment

fn can_start_end_non_code(&self) -> bool

fn dialect(&self) -> DialectKind

fn type_name(&self) -> &'static str

fn get_start_loc(&self) -> (usize, usize)

fn get_end_loc(&self) -> (usize, usize)

fn to_serialised( &self, code_only: bool, show_raw: bool, include_meta: bool, ) -> TupleSerialisedSegment

fn raw_segments_with_ancestors( &self, ) -> &OnceCell<Vec<(ErasedSegment, Vec<PathStep>)>>

fn select_children( &self, start_seg: Option<&ErasedSegment>, stop_seg: Option<&ErasedSegment>, select_if: Option<fn(_: &ErasedSegment) -> bool>, loop_while: Option<fn(_: &ErasedSegment) -> bool>, ) -> Vec<ErasedSegment>

fn is_templated(&self) -> bool

fn iter_segments( &self, expanding: Option<SyntaxSet>, pass_through: bool, ) -> Vec<ErasedSegment>

fn code_indices(&self) -> Vec<usize>

fn get_parent(&self) -> Option<ErasedSegment>

fn child(&self, seg_types: SyntaxSet) -> Option<ErasedSegment>

fn children(&self, seg_types: SyntaxSet) -> Vec<ErasedSegment>

fn iter_patches(&self, templated_file: &TemplatedFile) -> Vec<FixPatch>

fn descendant_type_set(&self) -> &SyntaxSet

fn get_raw_upper(&self) -> Option<String>

fn first_non_whitespace_segment_raw_upper(&self) -> Option<String>

fn is_type(&self, type_: SyntaxKind) -> bool

fn is_meta(&self) -> bool

fn get_default_raw(&self) -> Option<&'static str>

fn set_segments(&mut self, _segments: Vec<ErasedSegment>)

fn gather_segments(&self) -> Vec<ErasedSegment>

fn get_matched_length(&self) -> usize

Return the length of the segment in characters.

fn get_can_start_end_non_code(&self) -> bool

Are we able to have non-code at the start or end?

fn get_allow_empty(&self) -> bool

Can we allow it to be empty? Usually used in combination with the can_start_end_non_code.

fn get_file_path(&self) -> Option<String>

get_file_path returns the file path of the segment if it is a file segment.

fn iter_source_fix_patches( &self, templated_file: &TemplatedFile, ) -> Vec<FixPatch>

Yield any source patches as fixes now.

fn compute_anchor_edit_info( &self, fixes: &Vec<LintFix>, ) -> AHashMap<Uuid, AnchorEditInfo>

Group and count fixes by anchor, return dictionary.

fn combined_types(&self) -> SyntaxSet

impl StructuralPartialEq for SymbolSegment