gelx 0.8.5

Generate fully typed rust code from your gel schema and inline 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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174

#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc(html_logo_url = "https://raw.githubusercontent.com/ifiokjr/gelx/main/setup/assets/logo.png")]
#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/readme.md"))]
//! <br />
//! ## Features
#![doc = document_features::document_features!()]

use cfg_if::cfg_if;

cfg_if! {
	if #[cfg(feature = "query")] {
		mod client;
		pub use client::*;
	}
}

cfg_if! {
	if #[cfg(feature = "with_geo")] {
		mod geometry;

		pub use geometry::*;
		pub use geo;
		pub use geo_types;
		pub use geo_traits;
		pub use wkb;
	}
}

/// Generates a query module from a query string.
///
/// ```rust
/// use gelx::gelx;
///
/// gelx!(get_users, "select User {**}");
/// ```
///
/// This macro can be called with one argument if in the root of your crate you
/// host a folder named `queries`.
///
/// ```rust
/// use gelx::gelx;
///
/// gelx!(insert_user);
/// ```
///
/// The above code will find the file `<CRATE_ROOT>/queries/insert_user.edgeql`
/// and run the query from there.
///
/// If you want to customise the module name generated for a specific query
/// path, or just use a custom path for the generated macro in your codebase the
/// following options is also available.
///
/// ```rust
/// use gelx::gelx;
///
/// gelx!(custom_name_for_module, file: "queries/insert_user.edgeql");
/// ```
#[macro_export]
macro_rules! gelx {
	($module:ident, $query:literal) => {
		$crate::exports::gelx_macros::gelx_raw!($module, query: $query);
	};
	($module:ident, file: $path:literal) => {
		$crate::exports::gelx_macros::gelx_raw!($module, file: $path);
	};
	($module: ident) => {
		$crate::exports::gelx_macros::gelx_raw!($module);
	};
}

/// Generates a query module from a query string relative to the root of the
/// crate this is defined in. This is useful for queries that are not placed in
/// the `queries` folder at the root of the crate.
///
/// ```rust
/// use gelx::gelx_file;
///
/// gelx_file!(insert_user, "queries/insert_user.edgeql");
/// ```
///
/// The above code can actually be replaced with the
/// `gelx!(insert_user)` macro since the file is placed in the `queries`
/// folder.
#[deprecated(
	since = "0.5.0",
	note = "use `gelx!(insert_user, file: \"queries/insert_user.edgeql\")` instead"
)]
#[macro_export]
macro_rules! gelx_file {
	($module:ident, $path:literal) => {
		$crate::exports::gelx_macros::gelx_raw!($module, file: $path);
	};
}

pub mod exports {
	pub use bytes;
	use cfg_if::cfg_if;
	#[cfg(feature = "query")]
	#[cfg_attr(docsrs, doc(cfg(feature = "query")))]
	pub use gel_derive;
	pub use gel_errors;
	pub use gel_protocol;
	#[cfg(feature = "query")]
	#[cfg_attr(docsrs, doc(cfg(feature = "query")))]
	pub use gel_tokio;
	pub use gelx_macros;
	#[cfg(any(feature = "with_bigdecimal", feature = "with_bigint"))]
	#[cfg_attr(
		docsrs,
		doc(cfg(any(feature = "with_bigdecimal", feature = "with_bigint")))
	)]
	pub use num_bigint;
	#[cfg(any(feature = "with_bigdecimal", feature = "with_bigint"))]
	#[cfg_attr(
		docsrs,
		doc(cfg(any(feature = "with_bigdecimal", feature = "with_bigint")))
	)]
	pub use num_traits;
	#[cfg(feature = "serde")]
	#[cfg_attr(docsrs, doc(cfg(feature = "serde")))]
	pub use serde;
	#[cfg(feature = "strum")]
	#[cfg_attr(docsrs, doc(cfg(feature = "strum")))]
	pub use strum;
	#[cfg(feature = "builder")]
	#[cfg_attr(docsrs, doc(cfg(feature = "builder")))]
	pub use typed_builder;
	pub use uuid;

	cfg_if! {
		if #[cfg(feature = "with_bigdecimal")] {
			#[cfg_attr(docsrs, doc(cfg(feature = "with_bigdecimal")))]
			pub use bigdecimal;
			pub type DecimalAlias = bigdecimal::BigDecimal;
		} else {
			pub type DecimalAlias = gel_protocol::model::Decimal;
		}
	}

	cfg_if! {
		if #[cfg(feature = "with_chrono")] {
			#[cfg_attr(docsrs, doc(cfg(feature = "with_chrono")))]
			pub use chrono;
			pub type DateTimeAlias = chrono::DateTime<chrono::Utc>;
			pub type LocalDatetimeAlias = chrono::NaiveDateTime;
			pub type LocalDateAlias = chrono::NaiveDate;
			pub type LocalTimeAlias = chrono::NaiveTime;
		} else {
			pub type DateTimeAlias = gel_protocol::model::Datetime;
			pub type LocalDatetimeAlias = gel_protocol::model::LocalDatetime;
			pub type LocalTimeAlias = gel_protocol::model::LocalTime;
			pub type LocalDateAlias = gel_protocol::model::LocalDate;
		}
	}

	cfg_if! {
		if #[cfg(feature = "with_bigint")] {
			#[cfg_attr(docsrs, doc(cfg(feature = "with_bigint")))]
			pub type BigIntAlias = num_bigint::BigInt;
		} else {
			pub type BigIntAlias = gel_protocol::model::BigInt;
		}
	}

	cfg_if! {
		if #[cfg(feature = "with_geo")] {
			#[cfg_attr(docsrs, doc(cfg(feature = "with_geo")))]
			pub use super::Geometry;
			pub use super::Geography;
		}
	}

	pub use super::check_scalar;
}