cf-modkit-db-macros 0.2.2

Proc-macro derives for modkit-db secure ORM layer
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

# ModKit DB Macros

 Procedural macros used by `modkit-db`.

 Cargo package name: `cf-modkit-db-macros`
 Crate name (Rust import): `modkit_db_macros`

 ## Macros

 ### `#[derive(Scopable)]`

 Implements `modkit_db::secure::ScopableEntity` for a SeaORM entity.

 Put the derive on the `DeriveEntityModel` `Model` struct, together with a `#[secure(...)]` attribute.

 ```rust
 use modkit_db_macros::Scopable;
 use sea_orm::entity::prelude::*;
 use uuid::Uuid;

 #[derive(Clone, Debug, PartialEq, DeriveEntityModel, Scopable)]
 #[sea_orm(table_name = "users")]
 #[secure(tenant_col = "tenant_id", resource_col = "id", no_owner, no_type)]
 pub struct Model {
     #[sea_orm(primary_key, auto_increment = false)]
     pub id: Uuid,
     pub tenant_id: Uuid,
     pub email: String,
 }
 ```

 #### `#[secure(...)]` rules

 Either:

 - **Global entity**
 
   - `#[secure(unrestricted)]`
   - Must not be combined with any other `secure` settings.

 Or: specify all scope dimensions explicitly (no defaults):

 - **Tenant**
 
   - `tenant_col = "..."` or `no_tenant`
 - **Resource**
 
   - `resource_col = "..."` or `no_resource`
 - **Owner**
 
   - `owner_col = "..."` or `no_owner`
 - **Type**
 
   - `type_col = "..."` or `no_type`

 `*_col` values are column names. The macro maps `snake_case` to the SeaORM column variant using `UpperCamelCase` (e.g. `tenant_id` -> `TenantId`).

 ## Notes

 OData derive macros (e.g. `ODataFilterable`) are not exported from this crate.

## License

Licensed under Apache-2.0.