proxmox-mirrors/proxmox
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox synced 2025-05-28 14:44:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

api-macro: even more documentation

Browse Source 
Signed-off-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
This commit is contained in:
Wolfgang Bumiller 2020-01-08 11:28:00 +01:00
parent 0f630a4cb8
commit 1992abf96e
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
proxmox-api-macro/src/lib.rs
View File

@ -183,7 +183,8 @@ fn router_do(item: TokenStream) -> Result<TokenStream, Error> {
}
```
Note that the schema itself contains the already renamed fields!
Note that when writing out parts or all of the schema manually, the schema itself has to
contain the already renamed fields!
```
# use proxmox_api_macro::api;
@ -203,6 +204,13 @@ fn router_do(item: TokenStream) -> Result<TokenStream, Error> {
AND_MORE: String,
}
```
There are a few shortcuts for schemas: if the `type` refers to an arbitrary rust type other
than strings or integers, we assume that it has an `impl` block containing a `pub const
API_SCHEMA: &'static Schema`. This is what the `#[api]` macro produces on `struct` and `enum`
declarations. If it contains a `schema` key, this is expected to be the path to an existing
schema. (Hence `type: Foo` is the same as `schema: Foo::API_SCHEMA`.)
*/
#[proc_macro_attribute]
pub fn api(attr: TokenStream_1, item: TokenStream_1) -> TokenStream_1 {