Struct RuleScopedContext 

pub struct RuleScopedContext<'cx, 'ctx> { /* private fields */ }

A read-only scoped context bound to a rule key for diagnostics and slot extraction.

Implementations

impl RuleScopedContext<'_, '_>

pub fn invalid_shape(&self, message: impl Into<String>) -> RuleError

Creates an InvalidNodeShape error for the bound rule.

pub fn missing_metadata(&self, name: impl Into<String>) -> RuleError

Creates a MissingMetadata error for the bound rule.

pub fn ensure_shape( &self, condition: bool, message: impl Into<String>, ) -> Result<(), RuleError>

Returns Ok(()) when condition is true, or an invalid-shape error otherwise.

pub fn expect_arg_len( &self, args: &[ArgumentSlot], expected: usize, subject: &str, ) -> Result<(), RuleError>

Asserts that args has exactly expected slots, returning an error that names subject on mismatch.

pub fn expect_no_args( &self, args: &[ArgumentSlot], subject: &str, ) -> Result<(), RuleError>

Shorthand for expect_arg_len with expected = 0.

pub fn star_arg_value( &self, slot: &ArgumentSlot, subject: &str, ) -> Result<bool, RuleError>

Extracts a boolean star argument from a parsed star slot.

pub fn optional_math_content( &self, slot: &ArgumentSlot, subject: &str, label: &str, ) -> Result<Option<NodeId>, RuleError>

Extracts an optional math-content argument.

pub fn optional_group_math_content( &self, slot: &ArgumentSlot, subject: &str, label: &str, ) -> Result<Option<NodeId>, RuleError>

Extracts an optional braced-group math-content argument.

pub fn mandatory_math_content( &self, slot: &ArgumentSlot, subject: &str, label: &str, ) -> Result<NodeId, RuleError>

Extracts a mandatory math-content argument.

pub fn mandatory_or_group_math_content( &self, slot: &ArgumentSlot, subject: &str, label: &str, ) -> Result<NodeId, RuleError>

Extracts a math-content argument that may be either mandatory or a braced group.

Methods from Deref<Target = RuleContext<'ctx>>

pub fn for_rule(&self, rule: RuleKey) -> RuleScopedContext<'_, 'a>

Returns a lightweight context that binds diagnostics and slot extraction to one rule.

pub fn knows_command_name(&self, name: &str) -> bool

pub fn knows_env_name(&self, name: &str) -> bool

pub fn command_has_tag(&self, name: &str, tag: &str) -> bool

pub fn env_has_tag(&self, name: &str, tag: &str) -> bool

pub fn active_command(&self, node_id: NodeId) -> Option<&ActiveCommandRecord>

Looks up the active command record for the node at node_id by extracting its name from the AST.

pub fn active_env(&self, node_id: NodeId) -> Option<&ActiveEnvironmentRecord>

Looks up the active environment record for the node at node_id by extracting its name from the AST.

pub fn lookup_command( &self, name: &str, mode: ContentMode, ) -> Option<&ActiveCommandRecord>

Looks up a command record by name directly in the selected knowledge-base lane.

pub fn lookup_character( &self, name: &str, mode: ContentMode, ) -> Option<&ActiveCharacterRecord>

Looks up a character record by name directly in the selected knowledge-base lane.

pub fn lookup_env( &self, name: &str, mode: ContentMode, ) -> Option<&ActiveEnvironmentRecord>

Looks up an environment record by name directly in the selected knowledge-base lane.

pub fn node(&self, node_id: NodeId) -> &Node

Returns the AST node for the given identifier.

pub fn invalid_shape( &self, _rule: RuleKey, message: impl Into<String>, ) -> RuleError

Creates an InvalidNodeShape error for the given rule.

pub fn missing_metadata( &self, _rule: RuleKey, name: impl Into<String>, ) -> RuleError

Creates a MissingMetadata error for the given rule.

pub fn ensure_shape( &self, condition: bool, rule: RuleKey, message: impl Into<String>, ) -> Result<(), RuleError>

Returns Ok(()) when condition is true, or an InvalidNodeShape error otherwise.

pub fn expect_arg_len( &self, rule: RuleKey, args: &[ArgumentSlot], expected: usize, subject: &str, ) -> Result<(), RuleError>

Asserts that args has exactly expected slots, returning an error that names subject on mismatch.

pub fn expect_no_args( &self, rule: RuleKey, args: &[ArgumentSlot], subject: &str, ) -> Result<(), RuleError>

Shorthand for expect_arg_len with expected = 0.

pub fn match_command( &self, node_id: NodeId, record: &'static BuiltinCommandRecord, ) -> Option<CommandView<'_>>

Tries to extract a CommandView from the node, returning None if it is not a matching prefix command.

pub fn match_infix( &self, node_id: NodeId, record: &'static BuiltinCommandRecord, ) -> Option<InfixView<'_>>

Tries to extract an InfixView from the node, returning None if it is not a matching infix command.

pub fn match_declarative( &self, node_id: NodeId, record: &'static BuiltinCommandRecord, ) -> Option<DeclarativeView<'_>>

Tries to extract a DeclarativeView from the node, returning None if it is not a matching declarative command.

pub fn match_environment( &self, node_id: NodeId, record: &'static BuiltinEnvironmentRecord, ) -> Option<EnvironmentView<'_>>

Tries to extract an EnvironmentView from the node, returning None if it is not a matching environment.

Trait Implementations

impl<'cx, 'ctx> Deref for RuleScopedContext<'cx, 'ctx>

type Target = RuleContext<'ctx>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.