apinotes 0.0.2

Parsing clang API notes
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 serde::Deserialize;

use crate::map_helper::MapKey;
use crate::{General, Map, Nullability, Type};

#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize)]
pub enum Kind {
    Instance,
    Class,
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct MethodKey {
    pub selector: String,
    #[serde(rename = "MethodKind")]
    pub kind: Kind,
}

impl<'de> MapKey<'de> for MethodKey {
    type Inner = Self;
    fn from_inner(inner: Self::Inner) -> Self {
        inner
    }
    const CONTAIN_ERROR: &'static str = "a `Selector` and a `MethodKind` attribute";
}

#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub struct PropertyKey {
    pub name: String,
    /// `None` means that the property signifies both a class and an instance
    /// property.
    #[serde(rename = "PropertyKind")]
    #[serde(default)]
    pub kind: Option<Kind>,
}

impl<'de> MapKey<'de> for PropertyKey {
    type Inner = Self;
    fn from_inner(inner: Self::Inner) -> Self {
        inner
    }
    const CONTAIN_ERROR: &'static str = "a `Name` and a `PropertyKind` attribute";
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Method {
    #[serde(flatten)]
    pub general: General,
    /// Note: May not work due to compiler bugs
    pub nullability_of_ret: Option<Nullability>,
    pub nullability: Option<Vec<Nullability>>,
    pub result_type: Option<Type>,
    pub designated_init: bool,
    #[serde(with = "crate::map_helper")]
    pub parameters: Map<Position, Parameter>,
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Property {
    #[serde(flatten)]
    pub general: General,
    pub nullability: Option<Nullability>,
    // Default = false
    #[serde(default)]
    pub swift_import_as_accessors: bool,
    #[serde(rename = "Type")]
    pub type_: Option<Type>,
}

pub type Position = u8;

#[derive(Debug, Deserialize)]
#[serde(rename_all = "PascalCase")]
pub(crate) struct PositionHelper {
    position: Position,
}

impl<'de> MapKey<'de> for Position {
    type Inner = PositionHelper;
    fn from_inner(inner: Self::Inner) -> Self {
        inner.position
    }
    const CONTAIN_ERROR: &'static str = "a `Position` attribute";
}

#[derive(Clone, Debug, Default, PartialEq, Deserialize)]
#[serde(rename_all = "PascalCase")]
#[serde(default)]
#[non_exhaustive]
pub struct Parameter {
    #[serde(flatten)]
    pub general: General,
    pub nullability: Option<Nullability>,
    #[serde(rename = "Type")]
    pub type_: Option<Type>,
    /// Only used on block parameters.
    pub no_escape: bool,
}