trustfall_stubgen 0.5.0

Generate a Trustfall adapter stub for a given schema.
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

//! # trustfall_stubgen
//!
//! Given a Trustfall schema, autogenerate a high-quality Rust adapter stub
//! fully wired up with all types, properties, and edges referenced in the schema.
//!
//! First, install the CLI with: `cargo install --locked trustfall_stubgen --features cli`
//! Then generate Trustfall adapter stubs for your schema with:
//! ```text
//! trustfall_stubgen --schema <your_schema.graphql> --target <output_directory>
//! ```
//! Under the hood this directly calls the [`generate_rust_stub`] function from this crate.
//! This crate can also be used as a library, so you can call that function directly from
//! your own code without going through the CLI.
//!
//! The generated Trustfall adapter stub has the following structure:
//!
//! | file name               | purpose                                                |
//! | ----------------------- | ------------------------------------------------------ |
//! | adapter/mod.rs          | connects everything together                           |
//! | adapter/schema.graphql  | contains the schema for the adapter                    |
//! | adapter/adapter_impl.rs | contains the adapter implementation                    |
//! | adapter/vertex.rs       | contains the vertex type definition                    |
//! | adapter/entrypoints.rs  | contains the entry points where all queries must start |
//! | adapter/properties.rs   | contains the property implementations                  |
//! | adapter/edges.rs        | contains the edge implementations                      |
//!
//! See an example of
//! [a generated adapter stub](https://github.com/obi1kenobi/trustfall/tree/main/trustfall_stubgen/test_data/expected_outputs/hackernews/adapter)
//! from this crate's test suite.
#![forbid(unsafe_code)]
#![forbid(unused_lifetimes)]
#![forbid(elided_lifetimes_in_paths)]

mod adapter_creator;
mod edges_creator;
mod entrypoints_creator;
mod properties_creator;
mod root;
mod util;

#[cfg(test)]
mod tests;

pub use root::generate_rust_stub;