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

use bytes::Bytes;
use gel_protocol::codec::POSTGIS_GEOGRAPHY;
use gel_protocol::codec::POSTGIS_GEOMETRY;
use gel_protocol::descriptors::Descriptor;
use gel_protocol::descriptors::TypePos;
use gel_protocol::errors;
use gel_protocol::errors::DecodeError;
use gel_protocol::queryable::Decoder;
use gel_protocol::queryable::DescriptorContext;
use gel_protocol::queryable::DescriptorMismatch;
use gel_protocol::queryable::Queryable;
use gel_protocol::value::Value;
use geo_traits::to_geo::ToGeoGeometry;
use uuid::Uuid;
use wkb::Endianness;
use wkb::reader::read_wkb;
use wkb::writer::WriteOptions;
use wkb::writer::write_geometry;

/// A wrapper for the[`geo::Geometry`] enum with support for WKB encoding and
/// interop with the `ext::postgis::geometry` type.
///
/// This type can be used as a queryable type in the `ext::postgis::geometry`
/// type.
///
/// TODO SRID support or an alternative would be creating a way to automatically
/// infer the SRID from the geometry: <https://raw.githubusercontent.com/rustprooflabs/srid-bbox/refs/heads/main/srid_bbox.sql>
///
/// ```
/// use gelx::Geometry;
/// use gelx::geo::point;
///
/// let geometry = Geometry(point!(x: 1.0, y: 1.0).into());
/// ```
#[derive(
	Debug, Clone, derive_more::Deref, derive_more::DerefMut, derive_more::From, derive_more::Into,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Geometry(pub geo::Geometry);

impl Queryable for Geometry {
	type Args = ();

	fn decode(_: &Decoder, (): &Self::Args, buf: &[u8]) -> Result<Self, DecodeError> {
		let geometry: geo::Geometry = match read_wkb(buf) {
			Ok(value) => {
				let Some(value) = value.try_to_geometry() else {
					return errors::MissingRequiredElement.fail();
				};
				value
			}
			Err(_) => return errors::MissingRequiredElement.fail(),
		};

		Ok(Self(geometry))
	}

	fn check_descriptor(
		ctx: &DescriptorContext,
		type_pos: TypePos,
	) -> Result<Self::Args, DescriptorMismatch> {
		check_scalar(ctx, type_pos, POSTGIS_GEOMETRY, "ext::postgis::geometry")?;
		Ok(())
	}
}

impl From<Geometry> for Value {
	fn from(value: Geometry) -> Self {
		let mut buf = vec![];

		write_geometry(
			&mut buf,
			&value.0,
			&WriteOptions {
				endianness: Endianness::BigEndian,
			},
		)
		.unwrap();

		Value::PostGisGeometry(Bytes::from(buf))
	}
}

/// Another wrapper struct for the [`geo::Geometry`] enum with support for WKB
/// encoding and interop with the `ext::postgis::geography` type.
///
/// This type can be used as a queryable type in the `ext::postgis::geography`
/// type.
///
/// ```
/// use gelx::Geography;
/// use gelx::geo::point;
///
/// let geography = Geography(point!(x: 1.0, y: 1.0).into());
/// ```
#[derive(
	Debug, Clone, derive_more::Deref, derive_more::DerefMut, derive_more::From, derive_more::Into,
)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Geography(pub geo::Geometry);

impl Queryable for Geography {
	type Args = ();

	fn decode(_: &Decoder, (): &Self::Args, buf: &[u8]) -> Result<Self, DecodeError> {
		let geometry: geo::Geometry = match read_wkb(buf) {
			Ok(value) => {
				let Some(value) = value.try_to_geometry() else {
					return errors::MissingRequiredElement.fail();
				};
				value
			}
			Err(_) => return errors::MissingRequiredElement.fail(),
		};

		Ok(Self(geometry))
	}

	fn check_descriptor(
		ctx: &DescriptorContext,
		type_pos: TypePos,
	) -> Result<Self::Args, DescriptorMismatch> {
		check_scalar(ctx, type_pos, POSTGIS_GEOGRAPHY, "ext::postgis::geography")?;
		Ok(())
	}
}

impl From<Geography> for Value {
	fn from(value: Geography) -> Self {
		let mut buf = vec![];

		write_geometry(
			&mut buf,
			&value.0,
			&WriteOptions {
				endianness: Endianness::BigEndian,
			},
		)
		.unwrap();

		Value::PostGisGeography(Bytes::from(buf))
	}
}

pub fn check_scalar(
	ctx: &DescriptorContext,
	type_pos: TypePos,
	type_id: Uuid,
	name: &str,
) -> Result<(), DescriptorMismatch> {
	let desc = ctx.get(type_pos)?;

	match desc {
		Descriptor::Scalar(scalar) if scalar.base_type_pos.is_some() => {
			return check_scalar(ctx, scalar.base_type_pos.unwrap(), type_id, name);
		}

		Descriptor::Scalar(scalar) if *scalar.id == type_id => {
			return Ok(());
		}

		Descriptor::BaseScalar(base) if *base.id == type_id => {
			return Ok(());
		}
		_ => {}
	}

	Err(ctx.wrong_type(desc, name))
}