netlink-bindings 0.2.1-rev2

Type-safe Rust bindings for Netlink generated from YAML specifications
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
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409

# Operation "getfamily"

## Do (request)

```rust
PushOpGetfamilyDoRequest::new(&mut vec)
  .push_family_name(val) // &CStr
  .push_family_name_bytes(val) // &[u8]
  ;
```

```rust
let attrs = OpGetfamilyDoReply::new(buf);

attrs.get_family_id(); // u16
attrs.get_family_name(); // &CStr
attrs.get_hdrsize(); // u32
attrs.get_maxattr(); // u32

for entry in attrs.get_mcast_groups() {
  entry.get_name(); // &CStr
  entry.get_id(); // u32
}

for entry in attrs.get_ops() {
  entry.get_id(); // u32

  // Associated type: "OpFlags" (1 bit per enumeration)
  entry.get_flags(); // u32
}
attrs.get_version(); // u32
```

### Do (reply)

```rust
PushOpGetfamilyDoReply::new(&mut vec)
  .push_family_id(val) // u16
  .push_family_name(val) // &CStr
  .push_family_name_bytes(val) // &[u8]
  .push_hdrsize(val) // u32
  .push_maxattr(val) // u32
  .array_mcast_groups()
    .entry_nested()
      .push_name(val) // &CStr
      .push_name_bytes(val) // &[u8]
      .push_id(val) // u32
    .end_nested()
  .end_array()
  .array_ops()
    .entry_nested()
      .push_id(val) // u32

      // Associated type: "OpFlags" (1 bit per enumeration)
      .push_flags(val) // u32
    .end_nested()
  .end_array()
  .push_version(val) // u32
  ;
```

```rust
let attrs = OpGetfamilyDoReply::new(buf);

attrs.get_family_id(); // u16
attrs.get_family_name(); // &CStr
attrs.get_hdrsize(); // u32
attrs.get_maxattr(); // u32

for entry in attrs.get_mcast_groups() {
  entry.get_name(); // &CStr
  entry.get_id(); // u32
}

for entry in attrs.get_ops() {
  entry.get_id(); // u32

  // Associated type: "OpFlags" (1 bit per enumeration)
  entry.get_flags(); // u32
}
attrs.get_version(); // u32
```

## Low-level decoding

### Do (request)

```rust
let iter = OpGetfamilyDoRequest::new(buf);
for attr in iter {
  match attr {
    FamilyName(val) => {}, // &CStr
  }
}
```

### Do (reply)

```rust
let iter = OpGetfamilyDoReply::new(buf);
for attr in iter {
  match attr {
    FamilyId(val) => {}, // u16
    FamilyName(val) => {}, // &CStr
    Hdrsize(val) => {}, // u32
    Maxattr(val) => {}, // u32
    McastGroups(iter) => {
      for entry in iter {
        for attr in entry {
          match attr {
            Name(val) => {}, // &CStr
            Id(val) => {}, // u32
          }
        }
      }
    },
    Ops(iter) => {
      for entry in iter {
        for attr in entry {
          match attr {
            Id(val) => {}, // u32

            // Associated type: "OpFlags" (1 bit per enumeration)
            Flags(val) => {}, // u32
          }
        }
      }
    },
    Version(val) => {}, // u32
  }
}
```

## Dump (request)

```rust
PushOpGetfamilyDumpRequest::new(&mut vec)
  ;
```

```rust
let attrs = OpGetfamilyDumpReply::new(buf);

attrs.get_family_id(); // u16
attrs.get_family_name(); // &CStr
attrs.get_hdrsize(); // u32
attrs.get_maxattr(); // u32

for entry in attrs.get_mcast_groups() {
  entry.get_name(); // &CStr
  entry.get_id(); // u32
}

for entry in attrs.get_ops() {
  entry.get_id(); // u32

  // Associated type: "OpFlags" (1 bit per enumeration)
  entry.get_flags(); // u32
}
attrs.get_version(); // u32
```

### Dump (reply)

```rust
PushOpGetfamilyDumpReply::new(&mut vec)
  .push_family_id(val) // u16
  .push_family_name(val) // &CStr
  .push_family_name_bytes(val) // &[u8]
  .push_hdrsize(val) // u32
  .push_maxattr(val) // u32
  .array_mcast_groups()
    .entry_nested()
      .push_name(val) // &CStr
      .push_name_bytes(val) // &[u8]
      .push_id(val) // u32
    .end_nested()
  .end_array()
  .array_ops()
    .entry_nested()
      .push_id(val) // u32

      // Associated type: "OpFlags" (1 bit per enumeration)
      .push_flags(val) // u32
    .end_nested()
  .end_array()
  .push_version(val) // u32
  ;
```

```rust
let attrs = OpGetfamilyDumpReply::new(buf);

attrs.get_family_id(); // u16
attrs.get_family_name(); // &CStr
attrs.get_hdrsize(); // u32
attrs.get_maxattr(); // u32

for entry in attrs.get_mcast_groups() {
  entry.get_name(); // &CStr
  entry.get_id(); // u32
}

for entry in attrs.get_ops() {
  entry.get_id(); // u32

  // Associated type: "OpFlags" (1 bit per enumeration)
  entry.get_flags(); // u32
}
attrs.get_version(); // u32
```

## Low-level decoding

### Dump (request)

```rust
let iter = OpGetfamilyDumpRequest::new(buf);
// No attributes
```

### Dump (reply)

```rust
let iter = OpGetfamilyDumpReply::new(buf);
for attr in iter {
  match attr {
    FamilyId(val) => {}, // u16
    FamilyName(val) => {}, // &CStr
    Hdrsize(val) => {}, // u32
    Maxattr(val) => {}, // u32
    McastGroups(iter) => {
      for entry in iter {
        for attr in entry {
          match attr {
            Name(val) => {}, // &CStr
            Id(val) => {}, // u32
          }
        }
      }
    },
    Ops(iter) => {
      for entry in iter {
        for attr in entry {
          match attr {
            Id(val) => {}, // u32

            // Associated type: "OpFlags" (1 bit per enumeration)
            Flags(val) => {}, // u32
          }
        }
      }
    },
    Version(val) => {}, // u32
  }
}
```

# Operation "getpolicy"

## Dump (request)

```rust
PushOpGetpolicyDumpRequest::new(&mut vec)
  .push_family_name(val) // &CStr
  .push_family_name_bytes(val) // &[u8]
  .push_family_id(val) // u16
  .push_op(val) // u32
  ;
```

```rust
let attrs = OpGetpolicyDumpReply::new(buf);

attrs.get_family_id(); // u16
{ // Nested OpPolicy
  let attrs = attrs.get_op_policy();
  attrs.get_do(); // u32
  attrs.get_dump(); // u32
}
{ // Nested Policy
  let attrs = attrs.get_policy();

  // Associated type: "AttrType" (enum)
  attrs.get_type(); // u32
  attrs.get_min_value_s(); // i64
  attrs.get_max_value_s(); // i64
  attrs.get_min_value_u(); // u64
  attrs.get_max_value_u(); // u64
  attrs.get_min_length(); // u32
  attrs.get_max_length(); // u32
  attrs.get_policy_idx(); // u32
  attrs.get_policy_maxtype(); // u32
  attrs.get_bitfield32_mask(); // u32
  attrs.get_mask(); // u64
  attrs.get_pad(); // &[u8]
}
```

### Dump (reply)

```rust
PushOpGetpolicyDumpReply::new(&mut vec)
  .push_family_id(val) // u16
  .nested_op_policy()
    .push_do(val) // u32
    .push_dump(val) // u32
  .end_nested()
  .nested_policy()

    // Associated type: "AttrType" (enum)
    .push_type(val) // u32
    .push_min_value_s(val) // i64
    .push_max_value_s(val) // i64
    .push_min_value_u(val) // u64
    .push_max_value_u(val) // u64
    .push_min_length(val) // u32
    .push_max_length(val) // u32
    .push_policy_idx(val) // u32
    .push_policy_maxtype(val) // u32
    .push_bitfield32_mask(val) // u32
    .push_mask(val) // u64
    .push_pad(val) // &[u8]
  .end_nested()
  ;
```

```rust
let attrs = OpGetpolicyDumpReply::new(buf);

attrs.get_family_id(); // u16
{ // Nested OpPolicy
  let attrs = attrs.get_op_policy();
  attrs.get_do(); // u32
  attrs.get_dump(); // u32
}
{ // Nested Policy
  let attrs = attrs.get_policy();

  // Associated type: "AttrType" (enum)
  attrs.get_type(); // u32
  attrs.get_min_value_s(); // i64
  attrs.get_max_value_s(); // i64
  attrs.get_min_value_u(); // u64
  attrs.get_max_value_u(); // u64
  attrs.get_min_length(); // u32
  attrs.get_max_length(); // u32
  attrs.get_policy_idx(); // u32
  attrs.get_policy_maxtype(); // u32
  attrs.get_bitfield32_mask(); // u32
  attrs.get_mask(); // u64
  attrs.get_pad(); // &[u8]
}
```

## Low-level decoding

### Dump (request)

```rust
let iter = OpGetpolicyDumpRequest::new(buf);
for attr in iter {
  match attr {
    FamilyName(val) => {}, // &CStr
    FamilyId(val) => {}, // u16
    Op(val) => {}, // u32
  }
}
```

### Dump (reply)

```rust
let iter = OpGetpolicyDumpReply::new(buf);
for attr in iter {
  match attr {
    FamilyId(val) => {}, // u16
    OpPolicy(iter) => {
      for attr in iter {
        match attr {
          Do(val) => {}, // u32
          Dump(val) => {}, // u32
        }
      }
    },
    Policy(iter) => {
      for attr in iter {
        match attr {

          // Associated type: "AttrType" (enum)
          Type(val) => {}, // u32
          MinValueS(val) => {}, // i64
          MaxValueS(val) => {}, // i64
          MinValueU(val) => {}, // u64
          MaxValueU(val) => {}, // u64
          MinLength(val) => {}, // u32
          MaxLength(val) => {}, // u32
          PolicyIdx(val) => {}, // u32
          PolicyMaxtype(val) => {}, // u32
          Bitfield32Mask(val) => {}, // u32
          Mask(val) => {}, // u64
          Pad(val) => {}, // &[u8]
        }
      }
    },
  }
}
```