uniffi_bindgen 0.32.0

a multi-language bindings generator for rust (codegen and cli tooling)
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

/* 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/. */

use super::*;

// Checksums, these are used to check that the bindings were built against the same
// exported interface as the loaded library.
pub fn checksums(namespace: &initial::Namespace) -> Result<Vec<Checksum>> {
    let mut checksums = vec![];

    namespace.try_visit(|func: &initial::Function| {
        checksums.push(Checksum {
            checksum: func
                .checksum
                .ok_or_else(|| anyhow!("Checksum not set for {}", func.name))?,
            fn_name: RustFfiFunctionName(uniffi_meta::fn_checksum_symbol_name(
                &namespace.crate_name,
                &func.name,
            )),
        });
        Ok(())
    })?;

    namespace.try_visit(|int: &initial::Interface| {
        let interface_name = int.name.clone();
        // Note: we're specifically only visiting `int.methods` here.  This skips methods for
        // traits like `Debug` which live in the `uniffi_traits` vec and don't have checksums.
        int.methods.try_visit(|meth: &initial::Method| {
            checksums.push(Checksum {
                checksum: meth
                    .checksum
                    .ok_or_else(|| anyhow!("Checksum not set for {}", meth.name))?,
                fn_name: RustFfiFunctionName(uniffi_meta::method_checksum_symbol_name(
                    &namespace.crate_name,
                    &interface_name,
                    &meth.name,
                )),
            });
            Ok(())
        })?;
        int.try_visit(|cons: &initial::Constructor| {
            checksums.push(Checksum {
                checksum: cons
                    .checksum
                    .ok_or_else(|| anyhow!("Checksum not set for {}", cons.name))?,
                fn_name: RustFfiFunctionName(uniffi_meta::constructor_checksum_symbol_name(
                    &namespace.crate_name,
                    &interface_name,
                    &cons.name,
                )),
            });
            Ok(())
        })?;
        Ok(())
    })?;

    // Skip callback interfaces, since those don't get their checksums set currently.

    Ok(checksums)
}

pub fn ffi_uniffi_contract_version(namespace: &initial::Namespace) -> RustFfiFunctionName {
    RustFfiFunctionName(format!(
        "ffi_{}_uniffi_contract_version",
        &namespace.crate_name
    ))
}

pub fn ffi_definitions(namespace: &initial::Namespace) -> Result<Vec<FfiDefinition>> {
    let checksum_defs = checksums(namespace)?.into_iter().map(|checksum| {
        FfiDefinition::RustFunction(FfiFunction {
            name: checksum.fn_name,
            async_data: None,
            arguments: vec![],
            return_type: FfiReturnType {
                ty: Some(FfiType::UInt16),
            },
            has_rust_call_status_arg: false,
            kind: FfiFunctionKind::Checksum,
        })
    });
    let builtin_defs = [FfiDefinition::RustFunction(FfiFunction {
        name: ffi_uniffi_contract_version(namespace),
        async_data: None,
        arguments: vec![],
        return_type: FfiReturnType {
            ty: Some(FfiType::UInt32),
        },
        has_rust_call_status_arg: false,
        kind: FfiFunctionKind::UniffiContractVersion,
    })];
    Ok(builtin_defs.into_iter().chain(checksum_defs).collect())
}