wl-client-builder 0.2.0

Library for creating protocol bindings for wl-client
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

pub(crate) struct Protocol {
    pub(crate) name: String,
    pub(crate) _copyright: Option<Copyright>,
    pub(crate) description: Option<Description>,
    pub(crate) interfaces: Vec<Interface>,
}

pub(crate) struct Copyright {
    pub(crate) _body: String,
}

#[derive(Debug)]
pub(crate) struct Description {
    pub(crate) summary: Option<String>,
    pub(crate) body: String,
}

pub(crate) struct Interface {
    pub(crate) name: String,
    pub(crate) version: u32,
    pub(crate) description: Option<Description>,
    pub(crate) requests: Vec<Message>,
    pub(crate) events: Vec<Message>,
    pub(crate) enums: Vec<Enum>,
}

#[derive(Debug)]
pub(crate) struct Arg {
    pub(crate) name: String,
    pub(crate) ty: ArgType,
    pub(crate) summary: Option<String>,
    pub(crate) description: Option<Description>,
    pub(crate) interface: Option<String>,
    pub(crate) allow_null: bool,
    pub(crate) enum_: Option<String>,
}

#[derive(Copy, Clone, Debug, PartialEq)]
pub(crate) enum ArgType {
    NewId,
    Int,
    Uint,
    Fixed,
    String,
    Object,
    Array,
    Fd,
}

#[derive(Copy, Clone, Debug, PartialEq)]
pub(crate) enum MessageType {
    Destructor,
}

pub(crate) struct Entry {
    pub(crate) name: String,
    pub(crate) value: String,
    pub(crate) value_u32: u32,
    pub(crate) summary: Option<String>,
    pub(crate) since: Option<u32>,
    pub(crate) deprecated_since: Option<u32>,
    pub(crate) description: Option<Description>,
}

pub(crate) struct Enum {
    pub(crate) name: String,
    pub(crate) _since: Option<u32>,
    pub(crate) bitfield: bool,
    pub(crate) description: Option<Description>,
    pub(crate) entries: Vec<Entry>,
}

pub(crate) struct Message {
    pub(crate) name: String,
    pub(crate) ty: Option<MessageType>,
    pub(crate) since: Option<u32>,
    pub(crate) deprecated_since: Option<u32>,
    pub(crate) description: Option<Description>,
    pub(crate) args: Vec<Arg>,
}