derived-cms 0.6.1

Generate a CMS, complete with admin interface, headless API and database interface from Rust type definitions. Works in cunjunction with serde and ormlite and uses axum as a web server.
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

use std::{fmt::Display, future::Future};

use axum::extract::FromRequestParts;
pub use derived_cms_derive::Entity;
use generic_array::{ArrayLength, GenericArray};
use serde::{Deserialize, Serialize};

use crate::{
    app::AppError,
    column::{Column, ColumnInfo},
    context::ContextTrait,
    input::InputInfo,
};

pub trait EntityBase<S: ContextTrait>:
    for<'de> Deserialize<'de> + Serialize + Send + Sync + Unpin + 'static
{
    /// should usually be an UUID
    type Id: for<'de> Deserialize<'de> + Clone + Display + Serialize + Send;

    type Create: for<'de> Deserialize<'de> + Serialize + Send + Sync + Unpin + 'static;
    type Update: for<'de> Deserialize<'de> + Serialize + Send + Sync + Unpin + 'static;

    type NumberOfColumns: ArrayLength;

    fn name() -> &'static str;
    fn name_plural() -> &'static str;

    /// should return the value of the field used as primary key.
    fn id(&self) -> &Self::Id;

    fn columns() -> GenericArray<ColumnInfo, Self::NumberOfColumns>;
    fn column_values(&self) -> GenericArray<&dyn Column, Self::NumberOfColumns>;
    fn inputs(value: Option<&Self>) -> impl IntoIterator<Item = InputInfo<'_, S>>;
}

pub trait Entity<S: ContextTrait>:
    EntityBase<S> + Get<S> + List<S> + Create<S> + Update<S> + Delete<S>
{
}

pub trait Get<S: ContextTrait>: EntityBase<S> {
    type RequestExt: FromRequestParts<S> + Send + Sync + Clone;
    type Error: Into<AppError> + Serialize + Send;

    fn get(
        id: &<Self as EntityBase<S>>::Id,
        ext: Self::RequestExt,
    ) -> impl Future<Output = Result<Option<Self>, Self::Error>> + Send;
}

pub trait List<S: ContextTrait>: EntityBase<S> {
    type RequestExt: FromRequestParts<S> + Send + Sync + Clone;
    type Error: Into<AppError> + Serialize + Send;

    // TODO: limit & offset
    fn list(
        ext: Self::RequestExt,
    ) -> impl Future<Output = Result<impl IntoIterator<Item = Self>, Self::Error>> + Send;
}

pub trait Create<S: ContextTrait>: EntityBase<S> {
    type RequestExt: FromRequestParts<S> + Send + Sync + Clone;
    type Error: Into<AppError> + Serialize + Send;

    fn create(
        data: <Self as EntityBase<S>>::Create,
        ext: Self::RequestExt,
    ) -> impl Future<Output = Result<Self, Self::Error>> + Send;
}

pub trait Update<S: ContextTrait>: EntityBase<S> {
    type RequestExt: FromRequestParts<S> + Send + Sync + Clone;
    type Error: Into<AppError> + Serialize + Send;

    fn update(
        id: &<Self as EntityBase<S>>::Id,
        data: <Self as EntityBase<S>>::Update,
        ext: Self::RequestExt,
    ) -> impl Future<Output = Result<Self, Self::Error>> + Send;
}

pub trait Delete<S: ContextTrait>: EntityBase<S> {
    type RequestExt: FromRequestParts<S> + Send + Sync + Clone;
    type Error: Into<AppError> + Serialize + Send + Sync + Unpin + 'static;

    fn delete(
        id: &<Self as EntityBase<S>>::Id,
        ext: Self::RequestExt,
    ) -> impl Future<Output = Result<(), Self::Error>> + Send;
}