rorm 0.10.0

A asynchronous declarative ORM written in pure rust.
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

//! Marker traits which can be implemented on a [`FieldType`] to allow the usage of various aggregation functions.
//!
//! ## Using
//! The traits don't prodived any methods. Instead use the corresponding method on [`FieldProxy`].

use rorm_db::row::DecodeOwned;

#[cfg(doc)]
use crate::fields::proxy::FieldProxy;
use crate::fields::traits::{Array, FieldType};

/// Marker for [`FieldProxy::count`]
///
/// This is implemented for every [`SingleColumnFieldType`](crate::internal::field::SingleColumnField)
pub trait FieldCount: FieldType {}
impl<T> FieldCount for T where T: FieldType<Columns = Array<1>> {}

/// Marker for [`FieldProxy::sum`]
pub trait FieldSum: FieldType<Columns = Array<1>> {
    /// The aggregation result's type
    ///
    /// If `Self` is not `Option`, then this should be `Option<Self>`.
    /// If `Self` is a `Option`, then this should be just `Self`.
    type Result: DecodeOwned;
}

/// Marker for [`FieldProxy::avg`]
pub trait FieldAvg: FieldType<Columns = Array<1>> {}

/// Marker for [`FieldProxy::max`]
pub trait FieldMax: FieldType<Columns = Array<1>> {
    /// The aggregation result's type
    ///
    /// If `Self` is not `Option`, then this should be `Option<Self>`.
    /// If `Self` is a `Option`, then this should be just `Self`.
    type Result: DecodeOwned;
}

/// Marker for [`FieldProxy::min`]
pub trait FieldMin: FieldType<Columns = Array<1>> {
    /// The aggregation result's type
    ///
    /// If `Self` is not `Option`, then this should be `Option<Self>`.
    /// If `Self` is a `Option`, then this should be just `Self`.
    type Result: DecodeOwned;
}

/// Implements [`FieldSum`] and [`FieldAvg`] for its argument `T` and `Option<T>`
///
/// # Syntax
/// Pass the type to implement as first argument and pass the [`FieldSum::Result`] type with
/// the `sum_result` key:
/// ```compile_fail
/// impl_FieldSum_FieldAvg!(i16, sum_result: i64);
/// ```
#[allow(non_snake_case)]
#[macro_export]
macro_rules! impl_FieldSum_FieldAvg {
    ($arg:ty, sum_result: $ret:ty) => {
        impl $crate::fields::traits::FieldSum for $arg {
            type Result = Option<$ret>;
        }
        impl $crate::fields::traits::FieldSum for Option<$arg> {
            type Result = Option<$ret>;
        }
        impl $crate::fields::traits::FieldAvg for $arg {}
        impl $crate::fields::traits::FieldAvg for Option<$arg> {}
    };
}

/// Implements [`FieldMin`] and [`FieldMax`] for its argument `T` and `Option<T>`.
///
/// (The `Result` will always be `Option<T>`.)
///
/// # Syntax
/// For a type without generics simple pass it as argument:
/// ```fail_compile
/// impl_FieldMin_FieldMax!(String);
/// ```
///
/// If your type is generic, you have to add a dummy `impl<...>` before the type:
/// ```fail_compile
/// impl_FieldMin_FieldMax!(impl<const MAX_LEN: usize, Impl> MaxStr<MAX_LEN, Impl>);
/// ```
#[allow(non_snake_case)]
#[macro_export]
macro_rules! impl_FieldMin_FieldMax {
    (impl<$($generic:ident $( $const_name:ident : $const_type:ty )?),*> $arg:ty) => {
        $crate::impl_FieldMin_FieldMax!(@internal [<$($generic $( $const_name : $const_type )?),*>] $arg);
    };
    ($arg:ty) => {
        $crate::impl_FieldMin_FieldMax!(@internal [] $arg);
    };
    (@internal [$($generic:tt)*] $arg:ty) => {
        impl $($generic)* $crate::fields::traits::FieldMin for $arg
        where
            $arg: $crate::fields::traits::FieldType,
            Option<$arg>: $crate::db::row::DecodeOwned,
        {
            type Result = Option<$arg>;
        }
        impl $($generic)* $crate::fields::traits::FieldMin for Option<$arg>
        where
            Option<$arg>: $crate::fields::traits::FieldType,
            Option<$arg>: $crate::db::row::DecodeOwned,
        {
            type Result = Option<$arg>;
        }
        impl $($generic)* $crate::fields::traits::FieldMax for $arg
        where
            $arg: $crate::fields::traits::FieldType,
            Option<$arg>: $crate::db::row::DecodeOwned,
        {
            type Result = Option<$arg>;
        }
        impl $($generic)* $crate::fields::traits::FieldMax for Option<$arg>
        where
            Option<$arg>: $crate::fields::traits::FieldType,
            Option<$arg>: $crate::db::row::DecodeOwned,
        {
            type Result = Option<$arg>;
        }
    };
}