libgraphql_parser/ast/
mod.rs

1//! AST types for representing parsed GraphQL documents.
2//!
3//! This AST structure provides a zero-copy AST for GraphQL documents. All node
4//! types are parameterized over a `'src` lifetime that borrows strings
5//! (whenever possible) from the source text via [`Cow<'src, str>`].
6//!
7//! Each AST node has two conceptual layers:
8//!
9//! - **Semantic layer** (always present): Typed structs with names,
10//!   values, directives, and all GraphQL semantics.
11//!
12//! - **Syntax layer** (optional): Each node has an
13//!   `Option<XyzSyntax<'src>>` field that, when populated, contains
14//!   keyword/punctuation tokens with their trivia (whitespace,
15//!   comments, commas). This enables lossless source reconstruction
16//!   for formatter and IDE tooling.
17//!
18//! # Example
19//!
20//! ```rust
21//! use libgraphql_parser::ast;
22//! use libgraphql_parser::GraphQLParser;
23//!
24//! // Parse a string into an AST
25//! let parser = GraphQLParser::new("type Query { hello: String }");
26//! let result = parser.parse_schema_document();
27//!
28//! // Extract the `Query` type definition
29//! let doc: &ast::Document<'_> = result.valid().unwrap().0;
30//! let query_def = match &doc.definitions[0] {
31//!     ast::Definition::TypeDefinition(
32//!         ast::TypeDefinition::Object(obj),
33//!     ) => obj,
34//!     _ => panic!("expected an object type definition"),
35//! };
36//!
37//! // Count the number of fields on the `Query` object
38//! let num_query_fields = query_def.fields.len();
39//! # assert_eq!(num_query_fields, 1);
40//! println!("The `Query` object has {num_query_fields} fields.");
41//! ```
42//!
43//! [`Cow<'src, str>`]: std::borrow::Cow
44//! [`ByteSpan`]: crate::ByteSpan
45
46mod argument;
47mod ast_node;
48mod boolean_value;
49mod definition;
50mod definition_kind;
51mod delimiter_pair;
52mod directive_annotation;
53mod directive_definition;
54mod directive_location;
55mod document;
56mod document_kind;
57mod enum_type_definition;
58mod enum_type_extension;
59mod enum_value;
60mod enum_value_definition;
61mod field_selection;
62mod field_definition;
63mod float_value;
64mod fragment_definition;
65mod fragment_spread;
66mod inline_fragment;
67mod input_object_type_definition;
68mod input_object_type_extension;
69mod input_value_definition;
70mod int_value;
71mod interface_type_definition;
72mod interface_type_extension;
73mod list_type_annotation;
74mod list_value;
75mod name;
76mod named_type_annotation;
77mod null_value;
78mod nullability;
79mod object_field;
80mod object_type_definition;
81mod object_type_extension;
82mod object_value;
83mod operation_definition;
84mod operation_type;
85mod root_operation_type_definition;
86mod scalar_type_definition;
87mod scalar_type_extension;
88mod schema_definition;
89mod schema_extension;
90mod selection;
91mod selection_set;
92mod string_value;
93mod type_annotation;
94mod type_condition;
95mod type_definition;
96mod type_extension;
97mod union_type_definition;
98mod union_type_extension;
99mod value;
100mod variable_definition;
101mod variable_reference;
102
103#[cfg(test)]
104pub(crate) mod tests;
105
106pub use argument::Argument;
107pub use argument::ArgumentSyntax;
108pub use ast_node::AstNode;
109pub use boolean_value::BooleanValue;
110pub use boolean_value::BooleanValueSyntax;
111pub use definition::Definition;
112pub use definition_kind::DefinitionKind;
113pub use delimiter_pair::DelimiterPair;
114pub use directive_annotation::DirectiveAnnotation;
115pub use directive_annotation::DirectiveAnnotationSyntax;
116pub use directive_definition::DirectiveDefinition;
117pub use directive_definition::DirectiveDefinitionSyntax;
118pub use directive_location::DirectiveLocation;
119pub use directive_location::DirectiveLocationKind;
120pub use directive_location::DirectiveLocationSyntax;
121pub use document::Document;
122pub use document::DocumentSyntax;
123pub use document_kind::DocumentKind;
124pub use enum_type_definition::EnumTypeDefinition;
125pub use enum_type_definition::EnumTypeDefinitionSyntax;
126pub use enum_type_extension::EnumTypeExtension;
127pub use enum_type_extension::EnumTypeExtensionSyntax;
128pub use enum_value::EnumValue;
129pub use enum_value::EnumValueSyntax;
130pub use enum_value_definition::EnumValueDefinition;
131pub use field_selection::FieldSelection;
132pub use field_selection::FieldSelectionSyntax;
133pub use field_definition::FieldDefinition;
134pub use field_definition::FieldDefinitionSyntax;
135pub use float_value::FloatValue;
136pub use float_value::FloatValueSyntax;
137pub use fragment_definition::FragmentDefinition;
138pub use fragment_definition::FragmentDefinitionSyntax;
139pub use fragment_spread::FragmentSpread;
140pub use fragment_spread::FragmentSpreadSyntax;
141pub use inline_fragment::InlineFragment;
142pub use inline_fragment::InlineFragmentSyntax;
143pub use input_object_type_definition::InputObjectTypeDefinition;
144pub use input_object_type_definition::InputObjectTypeDefinitionSyntax;
145pub use input_object_type_extension::InputObjectTypeExtension;
146pub use input_object_type_extension::InputObjectTypeExtensionSyntax;
147pub use input_value_definition::InputValueDefinition;
148pub use input_value_definition::InputValueDefinitionSyntax;
149pub use int_value::IntValue;
150pub use int_value::IntValueSyntax;
151pub use interface_type_definition::InterfaceTypeDefinition;
152pub use interface_type_definition::InterfaceTypeDefinitionSyntax;
153pub use interface_type_extension::InterfaceTypeExtension;
154pub use interface_type_extension::InterfaceTypeExtensionSyntax;
155pub use list_type_annotation::ListTypeAnnotation;
156pub use list_type_annotation::ListTypeAnnotationSyntax;
157pub use list_value::ListValue;
158pub use list_value::ListValueSyntax;
159pub use name::Name;
160pub use name::NameSyntax;
161pub use named_type_annotation::NamedTypeAnnotation;
162pub use null_value::NullValue;
163pub use null_value::NullValueSyntax;
164pub use nullability::Nullability;
165pub use object_field::ObjectField;
166pub use object_field::ObjectFieldSyntax;
167pub use object_type_definition::ObjectTypeDefinition;
168pub use object_type_definition::ObjectTypeDefinitionSyntax;
169pub use object_type_extension::ObjectTypeExtension;
170pub use object_type_extension::ObjectTypeExtensionSyntax;
171pub use object_value::ObjectValue;
172pub use object_value::ObjectValueSyntax;
173pub use operation_definition::OperationDefinition;
174pub use operation_definition::OperationDefinitionSyntax;
175pub use operation_type::OperationKind;
176pub use root_operation_type_definition::RootOperationTypeDefinition;
177pub use root_operation_type_definition::RootOperationTypeDefinitionSyntax;
178pub use scalar_type_definition::ScalarTypeDefinition;
179pub use scalar_type_definition::ScalarTypeDefinitionSyntax;
180pub use scalar_type_extension::ScalarTypeExtension;
181pub use scalar_type_extension::ScalarTypeExtensionSyntax;
182pub use schema_definition::SchemaDefinition;
183pub use schema_definition::SchemaDefinitionSyntax;
184pub use schema_extension::SchemaExtension;
185pub use schema_extension::SchemaExtensionSyntax;
186pub use selection::Selection;
187pub use selection_set::SelectionSet;
188pub use selection_set::SelectionSetSyntax;
189pub use string_value::StringValue;
190pub use string_value::StringValueSyntax;
191pub use type_annotation::TypeAnnotation;
192pub use type_condition::TypeCondition;
193pub use type_condition::TypeConditionSyntax;
194pub use type_definition::TypeDefinition;
195pub use type_extension::TypeExtension;
196pub use union_type_definition::UnionTypeDefinition;
197pub use union_type_definition::UnionTypeDefinitionSyntax;
198pub use union_type_extension::UnionTypeExtension;
199pub use union_type_extension::UnionTypeExtensionSyntax;
200pub use value::Value;
201pub use variable_definition::VariableDefinition;
202pub use variable_definition::VariableDefinitionSyntax;
203pub use variable_reference::VariableReference;
204pub use variable_reference::VariableReferenceSyntax;
libgraphql_parser/ast/mod.rs

libgraphql_parser/ast/
mod.rs
