gitarena-macros 0.0.0

Helper macros for GitArena
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

use proc_macro::TokenStream;
use proc_macro_error::proc_macro_error;

use config::from_config as internal_from_config;
use config::from_optional_config as internal_from_optional_config;
use route::route as internal_route;

mod config;
mod route;

/// Creates resource handler, allowing multiple HTTP method guards.
/// This method is similar to the actix_web method `actix_web::route`
///
/// # Syntax
///
/// ```text
/// #[route("path", method = "HTTP_METHOD"[, attributes])]
/// ```
///
/// # Attributes
///
/// - `"path"` - Raw literal string with path for which to register handler.
/// - `method="HTTP_METHOD"` - Registers HTTP method to provide guard for. Upper-case string, "GET", "POST" for example.
/// - `guard="function_name"` - Registers function as guard using `actix_web::guard::fn_guard`
/// - `wrap="Middleware"` - Registers a resource middleware.
///
/// # Differences
///
/// 1. This macro requires `anyhow::Result` as a return type while the actix macro requires `actix_web::Result`
/// 2. This macro attaches `#[instrument(skip_all)]` from the tracing library to the function with the correct method name
///
#[proc_macro_attribute]
#[proc_macro_error]
pub fn route(args: TokenStream, input: TokenStream) -> TokenStream {
    internal_route(args, input)
}

#[proc_macro]
pub fn from_config(input: TokenStream) -> TokenStream {
    internal_from_config(input)
}

#[proc_macro]
pub fn from_optional_config(input: TokenStream) -> TokenStream {
    internal_from_optional_config(input)
}