reifydb-rql 0.6.0

ReifyDB Query Language (RQL) parser and AST
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

// SPDX-License-Identifier: AGPL-3.0-or-later
// Copyright (c) 2026 ReifyDB

//! Abstract syntax tree for RQL. The parser entry point `parse_str` tokenises a source string and emits an
//! `AstStatement` tree allocated in a bump arena tied to the source lifetime, so spans inside the AST can refer
//! back to fragments of the original text without copying.
//!
//! AST shapes are public so external tooling - formatters, linters, the explain renderer - can inspect parsed
//! queries without re-parsing them. Adding or renaming a public AST node is a breaking change for that tooling.

use tracing::instrument;

use crate::{Result, ast::ast::AstStatement, bump::Bump, token::tokenize};

#[allow(clippy::module_inception)]
pub mod ast;
pub mod identifier;
pub(crate) mod parse;

#[instrument(name = "rql::parse", level = "trace", skip(bump, str))]
pub fn parse_str<'b>(bump: &'b Bump, str: &'b str) -> Result<Vec<AstStatement<'b>>> {
	let tokens = tokenize(bump, str)?;
	let statements = parse::parse(bump, str, tokens.into_iter().collect())?;
	Ok(statements)
}