Struct sqruff_lib::core::rules::context::RuleContext

pub struct RuleContext<'a> {
    pub dialect: &'a Dialect,
    pub fix: bool,
    pub templated_file: Option<TemplatedFile>,
    pub path: Option<String>,
    pub config: Option<&'a FluffConfig>,
    pub segment: ErasedSegment,
    pub parent_stack: Vec<ErasedSegment>,
    pub raw_stack: Vec<ErasedSegment>,
    pub memory: Rc<RefCell<AnyMap>>,
    pub segment_idx: usize,
}

Struct for holding the context passed to rule eval function

Fields

dialect: &'a Dialect

fix: bool

templated_file: Option<TemplatedFile>

path: Option<String>

config: Option<&'a FluffConfig>

segment: ErasedSegment

segment: The segment in question

parent_stack: Vec<ErasedSegment>

parent_stack: A tuple of the path from the root to this segment.

raw_stack: Vec<ErasedSegment>

raw_stack: All of the raw segments so far in the file

memory: Rc<RefCell<AnyMap>>

memory: Arbitrary storage for the rule

segment_idx: usize

segment_idx: The index of this segment in the parent

Implementations

impl RuleContext<'_>

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

Trait Implementations

impl<'a> Clone for RuleContext<'a>

fn clone(&self) -> RuleContext<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for RuleContext<'a>

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

Formats the value using the given formatter.