decypher 0.2.0-alpha.6

A rust library for parsing openCypher queries.
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

#![cfg_attr(docsrs, doc(cfg(feature = "hir")))]

//! High-level intermediate representation (HIR) for Cypher queries.
//!
//! The HIR is a scope-resolved, normalised representation that sits between
//! the typed AST ([`crate::ast`]) and a hypothetical execution engine. It is
//! produced by the [`lower`] module.
//!
//! # Structure
//!
//! | Sub-module | Contents |
//! |---|---|
//! | [`arena`] | Arena allocators and interners for HIR IDs |
//! | [`binding`] | Scope and binding (variable) types |
//! | [`diagnostic`] | Semantic diagnostics produced during lowering |
//! | [`expr`] | HIR expression nodes (`HirExpr`, `ExprKind`, …) |
//! | [`lower`] | The AST → HIR lowering pass |
//! | [`ops`] | Pipeline operation types (`MatchOp`, `ProjectOp`, …) |
//! | [`pattern`] | Normalised graph pattern types |
//!
//! # Relationship to the AST
//!
//! The HIR differs from the AST in the following ways:
//! - Variables are replaced by compact arena [`BindingId`]s.
//! - Scopes are explicit and allocated in [`HirArenas`].
//! - Graph patterns are flattened into node/relationship lists.
//! - Queries are decomposed into a sequence of [`QueryPart`] pipelines.

pub mod aggregate_registry;
pub mod arena;
pub mod binding;
pub mod diagnostic;
pub mod expr;
pub mod lower;
pub mod ops;
pub mod pattern;
pub use aggregate_registry::AggregateRegistry;
pub mod config;
pub use config::LowerConfig;

pub use arena::{BindingId, ExprId, HirArenas, ScopeId};
pub use binding::{Binding, BindingKind, Scope};
pub use diagnostic::HirDiagnostic;
pub use expr::{ExprKind, HirExpr};
pub use ops::{Operation, QueryPart};
pub use pattern::{
    GraphPattern, NodePattern, RelationshipDirection, RelationshipLength, RelationshipPattern,
};

/// A fully lowered and scope-resolved HIR query.
///
/// Produced by [`lower::lower`] from a parsed [`crate::ast::query::Query`].
/// Contains all arenas and the pipeline of query parts.
///
/// > **Note:** `lower()` currently returns `Err(Diagnostics)` whenever any
/// > diagnostic is produced, so successful `HirQuery` values always have an
/// > empty `diagnostics` vector. Non-fatal warning support may be added in a
/// > future release.
#[derive(Debug, Clone)]
pub struct HirQuery {
    /// Arena storage for scopes, bindings, and expressions.
    pub arenas: HirArenas,
    /// The sequence of query parts (pipeline stages).
    pub parts: Vec<QueryPart>,
    /// Reserved for future non-fatal semantic diagnostics.
    ///
    /// Currently always empty: `lower()` returns `Err` on the first
    /// diagnostic rather than accumulating warnings here.
    pub diagnostics: Vec<HirDiagnostic>,
}