gir-parser 0.1.4

GObject Introspection GIR files parser
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

use xmlserde_derives::XmlDeserialize;

use crate::{
    attribute::Attribute,
    documentation::{DocDeprecated, DocStability, DocVersion, Documentation, SourcePosition},
    prelude::*,
    version::Version,
    AnyType, Stability, TransferOwnership,
};

#[derive(Clone, Debug, XmlDeserialize)]
#[xmlserde(root = b"property")]
#[xmlserde(deny_unknown_fields)]
pub struct Property {
    #[xmlserde(name = b"name", ty = "attr")]
    name: String,
    #[xmlserde(name = b"readable", ty = "attr")]
    readable: Option<bool>,
    #[xmlserde(name = b"writable", ty = "attr")]
    writable: Option<bool>,
    #[xmlserde(name = b"construct", ty = "attr")]
    construct: Option<bool>,
    #[xmlserde(name = b"construct-only", ty = "attr")]
    construct_only: Option<bool>,
    #[xmlserde(name = b"setter", ty = "attr")]
    setter: Option<String>,
    #[xmlserde(name = b"getter", ty = "attr")]
    getter: Option<String>,
    #[xmlserde(name = b"default-value", ty = "attr")]
    default_value: Option<String>,
    #[xmlserde(name = b"transfer-ownership", ty = "attr")]
    transfer_ownership: Option<TransferOwnership>,
    // Common attributes
    #[xmlserde(name = b"introspectable", ty = "attr")]
    introspectable: Option<bool>,
    #[xmlserde(name = b"deprecated", ty = "attr")]
    deprecated: Option<bool>,
    #[xmlserde(name = b"version", ty = "attr")]
    version: Option<Version>,
    #[xmlserde(name = b"deprecated-version", ty = "attr")]
    deprecated_version: Option<Version>,
    #[xmlserde(name = b"stability", ty = "attr")]
    stability: Option<Stability>,
    // Documentation
    #[xmlserde(name = b"doc", ty = "child")]
    doc: Option<Documentation>,
    #[xmlserde(name = b"doc-deprecated", ty = "child")]
    doc_deprecated: Option<DocDeprecated>,
    #[xmlserde(name = b"doc-stability", ty = "child")]
    doc_stability: Option<DocStability>,
    #[xmlserde(name = b"doc-version", ty = "child")]
    doc_version: Option<DocVersion>,
    #[xmlserde(name = b"source-position", ty = "child")]
    source_position: Option<SourcePosition>,
    // Attributes: 0 or more
    #[xmlserde(name = b"attribute", ty = "child")]
    attributes: Vec<Attribute>,
    #[xmlserde(name = b"type", ty = "child")]
    type_: AnyType,
}

impl Property {
    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn is_readable(&self) -> bool {
        self.readable.unwrap_or(true)
    }

    pub fn is_writable(&self) -> bool {
        self.writable.unwrap_or(false)
    }

    pub fn is_construct(&self) -> bool {
        self.construct.unwrap_or(false)
    }

    pub fn is_construct_only(&self) -> bool {
        self.construct_only.unwrap_or(false)
    }

    pub fn transfer_ownership(&self) -> TransferOwnership {
        self.transfer_ownership.unwrap_or(TransferOwnership::None)
    }

    pub fn getter(&self) -> Option<&str> {
        self.getter.as_deref()
    }

    pub fn setter(&self) -> Option<&str> {
        self.setter.as_deref()
    }

    pub fn default_value(&self) -> Option<&str> {
        self.default_value.as_deref()
    }

    pub fn ty(&self) -> &AnyType {
        &self.type_
    }
}

impl_info!(Property);
impl_documentable!(Property);
impl_attributable!(Property);