fn-ptr 0.9.1

A utility crate for introspecting and rewriting function pointer types at compile time.
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147

use crate::AbiValue;

/// Type-level marker trait for function abi.
///
/// Types implementing this trait represent a specific `extern "..."` abi.
///
/// See [`Abi`] for the runtime representation.
pub trait Abi {
    /// The exact abi string used in `extern "..."`.
    const STR: &'static str;

    /// The runtime [`Abi`] that represent this marker type.
    const VALUE: AbiValue;

    /// The runtime [`Abi`] that represent this marker type.
    const ALLOWS_UNWIND: bool = Self::VALUE.allows_unwind();
}

/// Helper macro to implement [`Abi`].
macro_rules! define_abi_marker {
    ($name:ident, $lit:literal) => {
        #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
        #[doc = "Type-level marker for the `"]
        #[doc = $lit]
        #[doc = "` abi."]
        pub struct $name;

        impl Abi for $name {
            const STR: &'static str = $lit;
            const VALUE: AbiValue = AbiValue::from_str_const($lit).unwrap();
        }
    };
}

// Universal
define_abi_marker!(C, "C");
define_abi_marker!(CUnwind, "C-unwind");
define_abi_marker!(System, "system");
define_abi_marker!(SystemUnwind, "system-unwind");

// Rust
define_abi_marker!(Rust, "Rust");

// ARM
define_abi_marker!(Aapcs, "aapcs");
define_abi_marker!(AapcsUnwind, "aapcs-unwind");

// x86
define_abi_marker!(Cdecl, "cdecl");
define_abi_marker!(CdeclUnwind, "cdecl-unwind");
define_abi_marker!(Stdcall, "stdcall");
define_abi_marker!(StdcallUnwind, "stdcall-unwind");
define_abi_marker!(Fastcall, "fastcall");
define_abi_marker!(FastcallUnwind, "fastcall-unwind");
define_abi_marker!(Thiscall, "thiscall");
define_abi_marker!(ThiscallUnwind, "thiscall-unwind");
define_abi_marker!(Vectorcall, "vectorcall");
define_abi_marker!(VectorcallUnwind, "vectorcall-unwind");

// x86_64
define_abi_marker!(SysV64, "sysv64");
define_abi_marker!(SysV64Unwind, "sysv64-unwind");
define_abi_marker!(Win64, "win64");
define_abi_marker!(Win64Unwind, "win64-unwind");

// Other
define_abi_marker!(EfiApi, "efiapi");

/// Macro to convert an abi string to the corresponding [`Abi`] marker type.
#[macro_export]
macro_rules! abi {
    // Common
    ("Rust") => {
        $crate::abi::Rust
    };
    ("C") => {
        $crate::abi::C
    };
    ("C-unwind") => {
        $crate::abi::CUnwind
    };
    ("system") => {
        $crate::abi::System
    };
    ("system-unwind") => {
        $crate::abi::SystemUnwind
    };

    // ARM
    ("aapcs") => {
        $crate::abi::Aapcs
    };
    ("aapcs-unwind") => {
        $crate::abi::AapcsUnwind
    };

    // x86
    ("cdecl") => {
        $crate::abi::Cdecl
    };
    ("cdecl-unwind") => {
        $crate::abi::CdeclUnwind
    };
    ("stdcall") => {
        $crate::abi::Stdcall
    };
    ("stdcall-unwind") => {
        $crate::abi::StdcallUnwind
    };
    ("fastcall") => {
        $crate::abi::Fastcall
    };
    ("fastcall-unwind") => {
        $crate::abi::FastcallUnwind
    };
    ("thiscall") => {
        $crate::abi::Thiscall
    };
    ("thiscall-unwind") => {
        $crate::abi::ThiscallUnwind
    };
    ("vectorcall") => {
        $crate::abi::Vectorcall
    };
    ("vectorcall-unwind") => {
        $crate::abi::VectorcallUnwind
    };

    // x86_64
    ("sysv64") => {
        $crate::abi::SysV64
    };
    ("sysv64-unwind") => {
        $crate::abi::SysV64Unwind
    };
    ("win64") => {
        $crate::abi::Win64
    };
    ("win64-unwind") => {
        $crate::abi::Win64Unwind
    };

    // Other
    ("efiapi") => {
        $crate::abi::EfiApi
    };
}