flutter_rust_bridge_codegen 2.12.0

Flutter/Dart <-> Rust binding generator, feature-rich, but seamless and simple
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

// Name "structure" not "struct", since the latter is a keyword

use crate::codegen::ir::mir::annotation::MirDartAnnotation;
use crate::codegen::ir::mir::comment::MirComment;
use crate::codegen::ir::mir::field::MirField;
use crate::codegen::ir::mir::ty::{MirContext, MirType, MirTypeTrait};
use crate::utils::namespace::{Namespace, NamespacedName};
use convert_case::{Case, Casing};

crate::mir! {
pub struct MirTypeStructRef {
    pub ident: MirStructIdent,
    pub is_exception: bool,
}

pub struct MirStructIdent(pub NamespacedName);

pub struct MirStruct {
    pub name: NamespacedName,
    pub wrapper_name: Option<String>,
    pub fields: Vec<MirField>,
    pub is_fields_named: bool,
    pub dart_metadata_raw: Vec<MirDartAnnotation>,
    pub ignore: bool,
    pub needs_json_serializable: bool,
    pub generate_hash: bool,
    pub generate_eq: bool,
    pub ui_state: bool,
    pub comments: Vec<MirComment>,
}
}

impl MirTypeStructRef {
    pub fn get<'a>(&self, mir_context: &'a impl MirContext) -> &'a MirStruct {
        (mir_context.struct_pool().get(&self.ident))
            // frb-coverage:ignore-start
            .unwrap_or_else(|| panic!("no entry found for key={:?}", self.ident))
        // frb-coverage:ignore-end
    }
}

impl MirTypeTrait for MirTypeStructRef {
    fn visit_children_types<F: FnMut(&MirType) -> bool>(
        &self,
        f: &mut F,
        _mir_context: &impl MirContext,
    ) {
        for field in &self.get(_mir_context).fields {
            field.ty.visit_types(f, _mir_context);
        }
    }

    fn safe_ident(&self) -> String {
        self.ident.0.name.to_case(Case::Snake)
    }

    fn rust_api_type(&self) -> String {
        self.ident.0.rust_style()
    }

    fn self_namespace(&self) -> Option<Namespace> {
        Some(self.ident.0.namespace.clone())
    }

    fn should_ignore(&self, mir_context: &impl MirContext) -> bool {
        self.get(mir_context).ignore
    }
}

impl MirStruct {
    pub fn effective_dart_metadata(&self) -> Vec<MirDartAnnotation> {
        let mut ans = self.dart_metadata_raw.clone();
        if self.needs_json_serializable && !dart_metadata_has_freezed(&ans) {
            ans.push(MirDartAnnotation {
                content: "freezed".to_string(),
                library: None,
            });
        }
        ans
    }

    pub fn using_freezed(&self) -> bool {
        dart_metadata_has_freezed(&self.effective_dart_metadata())
    }

    pub fn is_empty(&self) -> bool {
        self.fields.is_empty()
    }

    pub fn brackets_pair(&self) -> (char, char) {
        rust_brackets_pair(self.is_fields_named)
    }
}

fn dart_metadata_has_freezed(dart_metadata: &[MirDartAnnotation]) -> bool {
    dart_metadata.iter().any(|it| it.content == "freezed")
}

impl From<NamespacedName> for MirStructIdent {
    fn from(value: NamespacedName) -> Self {
        Self(value)
    }
}

pub fn rust_brackets_pair(keyword_arg: bool) -> (char, char) {
    if keyword_arg {
        ('{', '}')
    } else {
        ('(', ')')
    }
}