witchcraft-server-macros 6.1.0

Macro definitions used by witchcraft-server
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100

// Copyright 2022 Palantir Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#![allow(clippy::needless_doctest_main)]
use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::quote;
use syn::{Error, ItemFn};

/// Marks the entrypoint of a Witchcraft server.
///
/// This macro should be applied to a function taking 3 arguments: the server's install config, a `Refreshable` of the
/// server's runtime config, and a mutable reference to the `Witchcraft` context object. It is a simple convenience
/// function that wraps the annotated function in one that passes it to the `witchcraft_server::init` function.
///
/// # Examples
///
/// ```ignore
/// use conjure_error::Error;
/// use witchcraft_server::config::install::InstallConfig;
/// use witchcraft_server::config::runtime::RuntimeConfig;
/// use witchcraft_server::Witchcraft;
/// use refreshable::Refreshable;
///
/// #[witchcraft_server::main]
/// fn main(
///     install: InstallConfig,
///     runtime: Refreshable<RuntimeConfig, Error>,
///     wc: &mut Witchcraft,
/// ) -> Result<(), Error> {
///     // initialization code...
///     Ok(())
/// }
/// ```
///
/// Expands to:
///
/// ```ignore
/// use conjure_error::Error;
/// use witchcraft_server::config::install::InstallConfig;
/// use witchcraft_server::config::runtime::RuntimeConfig;
/// use witchcraft_server::Witchcraft;
/// use refreshable::Refreshable;
///
/// fn main() {
///     fn inner_main(
///         install: InstallConfig,
///         runtime: Refreshable<RuntimeConfig, Error>,
///         wc: &mut Witchcraft,
///     ) -> Result<(), Error> {
///         // initialization code...
///         Ok(())
///     }
///
///     witchcraft_server::init(inner_main)
/// }
/// ```
#[proc_macro_attribute]
pub fn main(args: TokenStream, input: TokenStream) -> TokenStream {
    if !args.is_empty() {
        return with_error(
            input,
            Error::new(
                Span::call_site(),
                "#[witchcraft_server::main] does not take arguments",
            ),
        );
    }

    let function = match syn::parse::<ItemFn>(input.clone()) {
        Ok(function) => function,
        Err(e) => return with_error(input, e),
    };
    let vis = &function.vis;
    let name = &function.sig.ident;

    quote! {
        #vis fn #name() {
            #function

            witchcraft_server::init(#name)
        }
    }
    .into()
}

fn with_error(mut tokens: TokenStream, error: Error) -> TokenStream {
    tokens.extend(TokenStream::from(error.into_compile_error()));
    tokens
}