hyperlane-macros 19.0.0

A comprehensive collection of procedural macros for building HTTP servers with enhanced functionality. This crate provides attribute macros that simplify HTTP request handling, protocol validation, response management, and request data extraction.
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

use crate::*;

/// Creates a protocol check function for protocol upgrade type validation.
///
/// # Arguments
///
/// - `&proc_macro2::Ident` - The protocol upgrade type identifier as an ident.
///
/// # Returns
///
/// Returns a closure that generates the protocol check code.
pub(crate) fn create_protocol_check(
    upgrade_type: &proc_macro2::Ident,
) -> impl FnOnce(&Ident) -> TokenStream2 {
    let upgrade_type_str: String = upgrade_type.to_string();
    move |context| {
        let check_fn: proc_macro2::Ident =
            Ident::new(&format!("is_{upgrade_type_str}"), context.span());
        quote! {
            if !#context.get_request().get_upgrade_type().#check_fn() {
                return;
            }
        }
    }
}

/// Implements a protocol upgrade type check macro.
///
/// This macro generates a handler function for a specific protocol upgrade type check.
/// It expands to a check that aborts the request if the upgrade type does not match.
///
/// # Arguments
///
/// - `$name` - The name of the generated handler function.
/// - `$submit_name` - The string name for macro registration as an ident.
/// - `$upgrade_type` - The protocol upgrade type identifier as an ident.
macro_rules! impl_protocol_check_macro {
    ($name:ident, $submit_name:ident, $upgrade_type:ident) => {
        pub(crate) fn $name(item: TokenStream, position: Position) -> TokenStream {
            inject(
                position,
                item,
                create_protocol_check(&proc_macro2::Ident::new(
                    stringify!($upgrade_type),
                    proc_macro2::Span::call_site(),
                )),
            )
        }
    };
}

impl_protocol_check_macro!(ws_upgrade_type_macro, ws_upgrade_type, ws);
impl_protocol_check_macro!(h2c_upgrade_type_macro, h2c_upgrade_type, h2c);
impl_protocol_check_macro!(tls_upgrade_type_macro, tls_upgrade_type, tls);
impl_protocol_check_macro!(unknown_upgrade_type_macro, unknown_upgrade_type, unknown);