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

pub struct RuleContext {
    pub dialect: Dialect,
    pub fix: bool,
    pub templated_file: Option<TemplatedFile>,
    pub path: Option<String>,
    pub config: FluffConfig,
    pub segment: Box<dyn Segment>,
    pub parent_stack: Vec<Box<dyn Segment>>,
    pub raw_stack: Vec<Box<dyn Segment>>,
    pub memory: HashMap<String, String>,
    pub segment_idx: usize,
}

Struct for holding the context passed to rule eval function

Fields

dialect: Dialect

fix: bool

templated_file: Option<TemplatedFile>

path: Option<String>

config: FluffConfig

segment: Box<dyn Segment>

segment: The segment in question

parent_stack: Vec<Box<dyn Segment>>

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

raw_stack: Vec<Box<dyn Segment>>

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

memory: HashMap<String, String>

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<Box<dyn Segment>>

Trait Implementations

impl Clone for RuleContext

fn clone(&self) -> RuleContext

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuleContext

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

Formats the value using the given formatter.

impl Default for RuleContext

fn default() -> Self

Returns the “default value” for a type.