kynos-macros 0.3.0

Procedural macros for the Kynos REST API framework.
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

//! `#[derive(QueryParams)]`.

use proc_macro::TokenStream;
use quote::quote;
use syn::{DeriveInput, parse_macro_input};

use crate::derive::{
    common::{named_fields, reject_duplicate_names, wire_names},
    params::{Param, construct, decode_field, parameters_body, query_encode_body, query_pairs},
};

pub(crate) fn expand(item: TokenStream) -> TokenStream {
    let input = parse_macro_input!(item as DeriveInput);
    match expand_inner(&input) {
        Ok(tokens) => tokens.into(),
        Err(error) => error.to_compile_error().into(),
    }
}

fn expand_inner(input: &DeriveInput) -> syn::Result<proc_macro2::TokenStream> {
    let fields = named_fields(input, "QueryParams")?;
    let names = wire_names(input, fields, "param")?;
    reject_duplicate_names(fields, &names, "query parameter")?;

    let name = &input.ident;
    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    let params = Param::pair(fields, &names);
    let rejection = quote!(::kynos::error::rejection::QueryRejection);

    let pairs = query_pairs();
    // The first occurrence wins. A repeated name is how a list is spelled in a
    // query string, and a group of named parameters is not the shape that
    // describes one -- 3.2's whole-query parameter is.
    let reads = params.iter().map(|param| {
        let wire = param.name();
        let found = quote! {
            pairs
                .iter()
                .find_map(|(name, value)| (name.as_str() == #wire).then_some(value.as_str()))
        };
        decode_field(param, &rejection, &found, "the parameter is required")
    });
    let value = construct(&params);

    let parameters = parameters_body(
        &params,
        &quote!(::kynos::openapi::ParameterIn::Query),
        false,
    );
    let encode = query_encode_body(&params);

    // Three implementations; see `path_params.rs` for why the directions are
    // separate traits.
    Ok(quote! {
        impl #impl_generics ::kynos::extract::params::query::QueryParams
            for #name #ty_generics #where_clause
        {
            fn parameters(
                registry: &mut ::kynos::schema::registry::Registry,
            ) -> ::std::vec::Vec<::kynos::openapi::Parameter> {
                #parameters
            }
        }

        impl #impl_generics ::kynos::extract::params::query::DecodeQuery
            for #name #ty_generics #where_clause
        {
            fn decode(
                query: ::core::option::Option<&str>,
            ) -> ::core::result::Result<Self, ::kynos::error::rejection::QueryRejection> {
                #pairs
                #(#reads)*
                #value
            }
        }

        impl #impl_generics ::kynos::extract::params::query::EncodeQuery
            for #name #ty_generics #where_clause
        {
            fn encode(&self) -> ::std::string::String {
                #encode
            }
        }
    })
}