Struct sqruff_lib::core::parser::match_result::MatchResult

pub struct MatchResult {
    pub matched_segments: Vec<ErasedSegment>,
    pub unmatched_segments: Vec<ErasedSegment>,
}

This should be the default response from any match method.

Primary arguments: matched_segments: A tuple of the segments which have been matched in this matching operation. unmatched_segments: A tuple of the segments, which come after the matched_segments which could not be matched.

Fields

matched_segments: Vec<ErasedSegment>

unmatched_segments: Vec<ErasedSegment>

Implementations

impl MatchResult

pub fn new( matched_segments: Vec<ErasedSegment>, unmatched_segments: Vec<ErasedSegment> ) -> Self

pub fn from_empty() -> Self

Construct an empty MatchResult.

pub fn from_unmatched(segments: Vec<ErasedSegment>) -> MatchResult

Construct a MatchResult from just unmatched segments.

pub fn from_matched(matched: Vec<ErasedSegment>) -> MatchResult

pub fn trimmed_matched_length(&self) -> usize

Return the length of the match in characters, trimming whitespace.

pub fn all_segments(&self) -> Vec<ErasedSegment>

Return a tuple of all the segments, matched or otherwise.

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_complete(&self) -> bool

Return true if everything has matched.

    Note: An empty match is not a match so will return False.

pub fn has_match(&self) -> bool

Return true if anything has matched.

Trait Implementations

impl Add for MatchResult

type Output = MatchResult

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl Clone for MatchResult

fn clone(&self) -> MatchResult

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MatchResult

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

Formats the value using the given formatter.

impl Display for MatchResult

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

Formats the value using the given formatter.