Struct ParseContext 

pub struct ParseContext { /* private fields */ }

Immutable parse context owning an isolated knowledge base.

A ParseContext is the main integration surface for callers that need to freeze a fully-built knowledge base, query metadata, and parse LaTeX formulas repeatedly.

Construction

Constructor	Loaded knowledge
empty()	Nothing
from_packages()	Named packages only
Default::default()	Default runtime packages
shared()	Same as above, lazily cached &'static ref

Implementations

impl ParseContext

pub fn builder() -> ParseContextBuilder

pub fn mutation_summary(&self) -> &MutationSummary

pub fn enabled_packages(&self) -> &[PackageName]

pub fn has_enabled_package(&self, package: PackageName) -> bool

pub fn empty() -> Self

Build an empty context with no package specs loaded.

Useful as a blank slate when every definition will be injected manually.

pub fn from_packages(packages: &[&str]) -> Self

Build a context from an explicit list of package names. The listed packages are imported in canonical order.

Panics

Panics if any package name is unrecognized. Use try_from_packages for fallible loading.

pub fn try_from_packages(packages: &[&str]) -> Result<Self, PackageLoadError>

Fallible variant of from_packages.

Returns PackageLoadError instead of panicking when a package name is unrecognized.

pub fn shared() -> &'static ParseContext

Borrow the lazily-initialized default-package context.

This is the cheapest way to parse with the default knowledge base: the context is built once on first call and shared for the process lifetime.

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

Check whether name is a registered delimiter control sequence.

pub fn lookup_delimiter_control(&self, name: &str) -> Option<&'static str>

Look up a delimiter control by name, returning the interned name.

pub fn lookup_delimiter( &self, name: &str, is_control_sequence: bool, mode: ContentMode, ) -> Option<&ActiveDelimiterRecord>

pub fn parse(&self, src: &str, config: &ParseConfig) -> ParseResult

Parse a LaTeX formula and return a unified output.

Uses chumsky’s output+errors semantics so that a partial syntax tree can coexist with diagnostics.

pub fn kb_for(&self, mode: ContentMode) -> &KnowledgeBase

Look up the active command metadata for name.

The active entry may come from an explicit command definition or a character-derived zero-arg view. Returns None if the name is unknown or has been suppressed.

pub fn math_kb(&self) -> &KnowledgeBase

pub fn text_kb(&self) -> &KnowledgeBase

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

Look up the active command metadata for name in the selected lane.

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

Look up only the explicit (non-character-derived) command for name.

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

Look up character metadata for a control sequence name.

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

Look up environment metadata by name.

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

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

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

Trait Implementations

impl Clone for ParseContext

fn clone(&self) -> ParseContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParseContext

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

Formats the value using the given formatter.

impl Default for ParseContext

fn default() -> Self

Returns the “default value” for a type.