uniffi_macros 0.31.2

a multi-language bindings generator for rust (convenience macros)
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

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

//! Functions, types and expressions to handle FFI operations.
//!
//! This module leverages the various traits defined in `uniffi_core::ffi_converter_traits` to provide functionality to the rest of `uniffi_macros`.
//! Keeping this layer separate makes it easier to handle changes to those traits.
//! See `uniffi_core::ffi_converter_traits` for the meaning of these functions.

use proc_macro2::TokenStream;
use quote::{quote, ToTokens};

// Lower function
pub fn lower(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lower<crate::UniFfiTag>>::lower
    }
}

// Lift type
pub fn lift_type(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lift<crate::UniFfiTag>>::FfiType
    }
}

// Lift function
pub fn try_lift(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lift<crate::UniFfiTag>>::try_lift
    }
}

/// Write function
pub fn write(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lower<crate::UniFfiTag>>::write
    }
}

/// Read function
pub fn try_read(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lift<crate::UniFfiTag>>::try_read
    }
}

/// Lower return type
pub fn lower_return_type(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LowerReturn<crate::UniFfiTag>>::ReturnType
    }
}

/// Lower return function
pub fn lower_return(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LowerReturn<crate::UniFfiTag>>::lower_return
    }
}

/// Lower error function
pub fn lower_error(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LowerError<crate::UniFfiTag>>::lower_error
    }
}

/// Lift return type
pub fn lift_return_type(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LiftReturn<crate::UniFfiTag>>::ReturnType
    }
}

/// Lift foreign return function
pub fn lift_foreign_return(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LiftReturn<crate::UniFfiTag>>::lift_foreign_return
    }
}

/// Handle failed lift function
pub fn lower_return_handle_failed_lift(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::LowerReturn<crate::UniFfiTag>>::handle_failed_lift
    }
}

/// LiftRef type
pub fn lift_ref_type(ty: impl ToTokens) -> TokenStream {
    quote! { <#ty as ::uniffi::LiftRef<crate::UniFfiTag>>::LiftType }
}

/// Lower into rust buffer function
pub fn lower_into_rust_buffer(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lower<crate::UniFfiTag>>::lower_into_rust_buffer
    }
}

/// Lift from rust buffer function
pub fn try_lift_from_rust_buffer(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::Lift<crate::UniFfiTag>>::try_lift_from_rust_buffer
    }
}

/// Expression for the TYPE_ID_META value for a type
pub fn type_id_meta(ty: impl ToTokens) -> TokenStream {
    quote! {
        <#ty as ::uniffi::TypeId<crate::UniFfiTag>>::TYPE_ID_META
    }
}