casdoor_sdk_rust/sdk/
models.rs

1use std::fmt::{Debug, Display};
2
3use serde::{de::DeserializeOwned, Deserialize, Serialize};
4
5pub trait Model: Debug + Clone + DeserializeOwned + Serialize {
6    /// Model identifier, used for splicing URLs.
7    fn ident() -> &'static str;
8    /// Models identifier, used for splicing URLs.
9    fn plural_ident() -> &'static str;
10    /// Indicate whether this model currently supports updating individual columns one by one.
11    fn support_update_columns() -> bool;
12    fn owner(&self) -> &str;
13    fn name(&self) -> &str;
14    fn id(&self) -> String {
15        format!("{}/{}", self.owner(), self.name())
16    }
17}
18
19#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
20#[serde(rename_all = "camelCase")]
21pub struct ModelModifyArgs<M> {
22    pub action: ModelAction,
23    pub model: M,
24    pub columns: Option<Vec<String>>,
25}
26
27#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
28#[serde(rename_all = "camelCase")]
29pub struct ModelAddArgs<M> {
30    pub model: M,
31}
32
33#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
34#[serde(rename_all = "camelCase")]
35pub struct ModelUpdateArgs<M> {
36    pub model: M,
37    pub columns: Vec<String>,
38}
39
40#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
41#[serde(rename_all = "camelCase")]
42pub struct ModelDeleteArgs<M> {
43    pub model: M,
44}
45
46
47#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
48#[serde(rename_all = "camelCase")]
49pub enum ModelAction {
50    Add,
51    Delete,
52    Update,
53}
54
55impl Display for ModelAction {
56    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
57        match self {
58            ModelAction::Add => write!(f, "add"),
59            ModelAction::Delete => write!(f, "delete"),
60            ModelAction::Update => write!(f, "update"),
61        }
62    }
63}
64
65
66#[derive(Debug, Default, Clone, Copy, Serialize, Deserialize, PartialEq, Eq)]
67pub enum ModelActionAffect {
68    #[default]
69    Affected,
70    Unaffected,
71}
72
73impl Display for ModelActionAffect {
74    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
75        match self {
76            Self::Affected => write!(f, "Affected"),
77            Self::Unaffected => write!(f, "Unaffected"),
78        }
79    }
80}
81
82impl ModelActionAffect {
83    pub fn is_affected(&self) -> bool {
84        matches!(self, ModelActionAffect::Affected)
85    }
86}
87
88#[derive(Debug, Clone, Serialize, Deserialize, Default, PartialEq, Eq)]
89pub struct QueryArgs {
90    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none")]
91    pub page_size: Option<i32>,
92    #[serde(rename = "p", skip_serializing_if = "Option::is_none")]
93    pub page: Option<i32>,
94    #[serde(rename = "field", skip_serializing_if = "Option::is_none")]
95    pub field: Option<String>,
96    #[serde(rename = "value", skip_serializing_if = "Option::is_none")]
97    pub value: Option<String>,
98    #[serde(rename = "sortField", skip_serializing_if = "Option::is_none")]
99    pub sort_field: Option<String>,
100    #[serde(rename = "sortOrder", skip_serializing_if = "Option::is_none")]
101    pub sort_order: Option<String>,
102}
103
104pub(crate) trait IsQueryArgs: Serialize {}
105
106impl IsQueryArgs for QueryArgs {}
107
108
109#[derive(Debug, Serialize, Deserialize)]
110#[serde(rename_all = "camelCase")]
111pub struct QueryResult<M> {
112    items: Vec<M>,
113    total: i64,
114}
115
116impl<M> From<(Vec<M>, i64)> for QueryResult<M> {
117    #[inline(always)]
118    fn from(value: (Vec<M>, i64)) -> Self {
119        Self {
120            items: value.0,
121            total: value.1,
122        }
123    }
124}
casdoor_sdk_rust/sdk/models.rs

casdoor_sdk_rust/sdk/
models.rs
