Struct TypedParser

Source

pub struct TypedParser<G: TypedGrammar> { /* private fields */ }

Expand description

Parser API parameterized by grammar type G.

Primarily for library/framework code over generated grammars.

Use this when grammar type is known at compile time.
Use top-level Parser for typical SQLite SQL app code.

Implementations§

Source §

impl<G: TypedGrammar> TypedParser<G>

Source

pub fn new(grammar: G) -> Self

Create a parser for grammar G with default ParserConfig.

Source

pub fn with_config(grammar: G, config: &ParserConfig) -> Self

Create a parser for grammar G with custom ParserConfig.

§Panics

Panics if parser allocation fails (out of memory).

Source

pub fn parse(&self, source: &str) -> TypedParseSession<G>

Parse a SQL script and return a typed statement session.

§Examples

use syntaqlite_syntax::typed::{grammar, TypedParser};
use syntaqlite_syntax::ParseOutcome;

let parser = TypedParser::new(grammar());
let mut session = parser.parse("SELECT 1;");
let stmt = match session.next() {
    ParseOutcome::Ok(stmt) => stmt,
    ParseOutcome::Done => panic!("expected statement"),
    ParseOutcome::Err(err) => panic!("unexpected parse error: {err}"),
};
assert!(stmt.root().is_some());

§Panics

Panics if another session from this parser is still active. Drop the previous session before starting a new one.

Source

pub fn register_macro(&mut self, name: &str, params: &[&str], body: &str)

Start incremental parsing for grammar G.

Use this when tokens arrive over time (editor completion, interactive parsing, macro-expansion pipelines).

§Examples

use syntaqlite_syntax::typed::{grammar, TypedParser};
use syntaqlite_syntax::TokenType;

let parser = TypedParser::new(grammar());
let mut session = parser.incremental_parse("SELECT 1");

let _ = session.feed_token(TokenType::Select, 0..6);
let _ = session.feed_token(TokenType::Integer, 7..8);
let _ = session.finish();

§Panics

Panics if another session from this parser is still active. Drop the previous session before starting a new one. Register a template macro with the parser.

The macro name will be expanded when name!(args) is encountered during batch parsing (parse()). The body uses $param placeholders that are substituted with the corresponding arguments.