Struct sqruff_lib::core::parser::segments::base::CommentSegment

pub struct CommentSegment { /* private fields */ }

Segment containing a comment.

Implementations

impl CommentSegment

pub fn new( raw: &str, position_maker: &PositionMarker, args: CommentSegmentNewArgs ) -> Box<dyn Segment>

Trait Implementations

impl Clone for CommentSegment

fn clone(&self) -> CommentSegment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CommentSegment

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

Formats the value using the given formatter.

impl Hash for CommentSegment

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CommentSegment

fn eq(&self, other: &CommentSegment) -> 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.

impl Segment for CommentSegment

fn new(&self, _segments: Vec<Box<dyn Segment>>) -> Box<dyn Segment>

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

fn class_types(&self) -> HashSet<String>

fn is_code(&self) -> bool

fn is_comment(&self) -> bool

fn is_whitespace(&self) -> bool

fn get_uuid(&self) -> Option<Uuid>

fn get_segments(&self) -> Vec<Box<dyn Segment>>

fn get_raw_segments(&self) -> Vec<Box<dyn Segment>>

Iterate raw segments, mostly for searching.

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

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

fn edit( &self, _raw: Option<String>, _source_fixes: Option<Vec<SourceFix>> ) -> Box<dyn Segment>

Stub.

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

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

fn is_templated(&self) -> bool

fn iter_segments( &self, expanding: Option<&[&str]>, pass_through: bool ) -> Vec<Box<dyn Segment>>

fn recursive_crawl_all(&self, reverse: bool) -> Vec<Box<dyn Segment>>

fn print_tree(&self)

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

fn get_parent(&self) -> Option<Box<dyn Segment>>

fn child(&self, seg_types: &[&str]) -> Option<Box<dyn Segment>>

fn children(&self, seg_types: &[&str]) -> Vec<Box<dyn Segment>>

fn path_to(&self, other: &Box<dyn Segment>) -> Vec<PathStep>

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

fn descendant_type_set(&self) -> HashSet<String>

fn match_grammar(&self) -> Option<Box<dyn Matchable>>

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

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

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

fn is_meta(&self) -> bool

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

fn segments(&self) -> &[Box<dyn Segment>]

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 indent_val(&self) -> usize

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

Return any source fixes as list.

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

Group and count fixes by anchor, return dictionary.

fn instance_types(&self) -> HashSet<String>

fn combined_types(&self) -> HashSet<String>

fn apply_fixes( &self, dialect: Dialect, fixes: HashMap<Uuid, AnchorEditInfo> ) -> (Box<dyn Segment>, Vec<Box<dyn Segment>>, Vec<Box<dyn Segment>>, bool)

fn raw_segments_with_ancestors(&self) -> Vec<(Box<dyn Segment>, Vec<PathStep>)>

impl StructuralPartialEq for CommentSegment