modql 0.4.1

Rust implementation for Model Query Language support
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

use crate::field::{Error, Result};
use crate::sea_utils::StringIden;
use crate::SIden;
use sea_query::{ColumnRef, DynIden, SimpleExpr, Value};
use sea_query::{IntoIden, ValueType};

#[derive(Debug, Clone)]
pub struct SeaField {
	pub iden: DynIden,
	pub column_ref: ColumnRef,
	pub value: SimpleExpr,
}

impl SeaField {
	pub fn sea_value(&self) -> Option<&Value> {
		if let SimpleExpr::Value(value) = &self.value {
			Some(value)
		} else {
			None
		}
	}

	pub fn value_into<T>(self) -> Result<T>
	where
		T: ValueType,
	{
		let SimpleExpr::Value(value) = self.value else {
			return Err(Error::FieldValueNotSeaValue);
		};

		T::try_from(value).map_err(|_| Error::FieldValueIntoTypeError {
			field_name: self.iden.to_string(),
		})
	}
}

#[derive(Default, Debug)]
pub struct FieldOptions {
	pub cast_as: Option<String>,
}

impl SeaField {
	/// Create a new SeaField from an `IntoIden` and `Into<SimpleExpr>` for the value
	pub fn new(iden: impl IntoIden, value: impl Into<SimpleExpr>) -> Self {
		Self::new_concrete(iden.into_iden(), value.into())
	}

	/// The concrete version of the new.
	pub fn new_concrete(iden: DynIden, value: SimpleExpr) -> Self {
		let column_ref = ColumnRef::Column(iden.clone());
		SeaField {
			iden,
			column_ref,
			value,
		}
	}

	/// Create a new SeaField for a static column name and a `Into<SimpleExpr>` for the value
	pub fn siden(iden: &'static str, value: impl Into<SimpleExpr>) -> Self {
		let iden = SIden(iden).into_iden();
		let column_ref = ColumnRef::Column(iden.clone());
		SeaField {
			iden,
			column_ref,
			value: value.into(),
		}
	}

	pub fn new_with_options(iden: impl IntoIden, value: SimpleExpr, options: FieldOptions) -> Self {
		let iden = iden.into_iden();
		let column_ref = ColumnRef::Column(iden.clone());
		let mut value = value;
		if let Some(cast_as) = options.cast_as {
			value = value.cast_as(StringIden(cast_as))
		}

		SeaField {
			iden,
			column_ref,
			value,
		}
	}
}

// region:    --- Froms

// From (DynIden, SimpleExpr)
impl From<(DynIden, SimpleExpr)> for SeaField {
	fn from(val: (DynIden, SimpleExpr)) -> Self {
		SeaField::new(val.0, val.1)
	}
}

impl From<(&'static str, SimpleExpr)> for SeaField {
	fn from(val: (&'static str, SimpleExpr)) -> Self {
		SeaField::new(SIden(val.0), val.1)
	}
}

// endregion: --- Froms