pact_ffi 0.5.3

Pact interface for foreign languages.
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

//! Provides a convenience macro for wrapping FFI code.

// All of this module is a macro and should not appear in the C header file
// or documentation.

#[doc(hidden)]
#[macro_export]
macro_rules! ffi_fn {
    ($(#[$doc:meta])* fn $name:ident($($arg:ident: $arg_ty:ty),*) -> $ret:ty $body:block $fail:block ) => {
        $(#[$doc])*
        #[no_mangle]
        #[allow(clippy::or_fun_call)]
        #[allow(clippy::not_unsafe_ptr_arg_deref)]
        pub extern "C" fn $name($($arg: $arg_ty),*) -> $ret {
            use $crate::error::catch_panic;

            ::tracing::debug!("{}::{} FFI function invoked", module_path!(), stringify!($name));

            $(
                ::tracing::trace!("@param {} = {:?}", stringify!($arg), $arg);
            )*

            let output = catch_panic(|| Ok($body)).unwrap_or($fail);

            ::tracing::trace!(output = ?output, "{} FFI function completed", stringify!($name));

            output
        }
    };

    ($(#[$doc:meta])* fn $name:ident($($arg:ident: $arg_ty:ty),*) $body:block ) => {
        $crate::ffi_fn!($(#[$doc])* fn $name($($arg: $arg_ty),*) -> () $body {});
    };

    // Support async functions as well, by wrapping them in a block_on call
    ($(#[$doc:meta])* async fn $name:ident($($arg:ident: $arg_ty:ty),*) -> $ret:ty $body:block $fail:block ) => {
        $(#[$doc])*
        #[no_mangle]
        #[allow(clippy::or_fun_call)]
        #[allow(clippy::not_unsafe_ptr_arg_deref)]
        pub extern "C" fn $name($($arg: $arg_ty),*) -> $ret {
            use $crate::error::catch_panic;

            ::tracing::debug!("{}::{} FFI function invoked", module_path!(), stringify!($name));

            $(
                ::tracing::trace!("@param {} = {:?}", stringify!($arg), $arg);
            )*

            let output = catch_panic(|| ::futures::executor::block_on(async { Ok($body) })).unwrap_or($fail);

            ::tracing::trace!(output = ?output, "{} FFI function completed", stringify!($name));

            output
        }
    };

    ($(#[$doc:meta])* async fn $name:ident($($arg:ident: $arg_ty:ty),*) $body:block ) => {
        $crate::ffi_fn!($(#[$doc])* async fn $name($($arg: $arg_ty),*) -> () $body {});
    };
}