libyang 1.1.0

YANG parser in Rust
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
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
use crate::RangeNode;
use std::{collections::HashMap, fmt::Debug};

#[derive(Debug, PartialEq, Clone)]
pub enum Node {
    Module(Box<ModuleNode>),
    Submodule(Box<SubmoduleNode>),
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ModuleNode {
    pub name: String,
    pub version: Option<String>,
    pub namespace: Option<String>,
    pub prefix: Option<String>,
    pub import: Vec<ImportNode>,
    pub include: Vec<IncludeNode>,
    pub organization: Option<String>,
    pub contact: Option<String>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub revision: Vec<RevisionNode>,
    pub d: DatadefNode,
    pub identity: Vec<IdentityNode>,
    pub typedef: Vec<TypedefNode>,
    pub extension: Vec<ExtensionNode>,
    pub grouping: Vec<GroupingNode>,
    pub augment: Vec<AugmentNode>,
    pub unknown: Vec<UnknownNode>,
    pub identities: HashMap<String, Vec<String>>,
}

impl ModuleNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct SubmoduleNode {
    pub name: String,
    pub version: Option<String>,
    pub belongs_to: Option<BelongsToNode>,
    pub import: Vec<ImportNode>,
    pub include: Vec<IncludeNode>,
    pub organization: Option<String>,
    pub contact: Option<String>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub revision: Vec<RevisionNode>,
    pub d: DatadefNode,
    pub identity: Vec<IdentityNode>,
    pub typedef: Vec<TypedefNode>,
    pub grouping: Vec<GroupingNode>,
    pub augment: Vec<AugmentNode>,
    pub unknown: Vec<UnknownNode>,
    pub identities: HashMap<String, Vec<String>>,
}

impl SubmoduleNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ImportNode {
    pub name: String,
    pub prefix: Option<String>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub revision_date: Option<String>,
}

impl ImportNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }

    pub fn prefix(&self) -> String {
        match &self.prefix {
            Some(s) => s.to_owned(),
            None => String::from(""),
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct IncludeNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub revision_date: Option<String>,
}

impl IncludeNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct RevisionNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
}

impl RevisionNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct BelongsToNode {
    pub name: String,
    pub prefix: Option<String>,
}

impl BelongsToNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct IdentityNode {
    pub name: String,
    pub base: Vec<String>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub status: Option<String>,
}

impl IdentityNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct DatadefNode {
    pub container: Vec<ContainerNode>,
    pub leaf: Vec<LeafNode>,
    pub leaf_list: Vec<LeafListNode>,
    pub list: Vec<ListNode>,
    pub choice: Vec<ChoiceNode>,
    pub anydata: Vec<AnydataNode>,
    pub anyxml: Vec<AnyxmlNode>,
    pub uses: Vec<UsesNode>,
}

impl DatadefNode {
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ContainerNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    pub presence: Option<PresenceNode>,
    pub config: Option<ConfigNode>,
    pub d: DatadefNode,
    pub must: Vec<MustNode>,
    pub unknown: Vec<UnknownNode>,
    pub action: Vec<ActionNode>,
}

impl ContainerNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct LeafNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    pub config: Option<ConfigNode>,
    pub type_stmt: Option<TypeNode>,
    pub mandatory: Option<MandatoryNode>,
    pub must: Vec<MustNode>,
    pub unknown: Vec<UnknownNode>,
}

impl LeafNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }

    pub fn is_mandatory(&self) -> bool {
        if let Some(node) = &self.mandatory {
            node.mandatory
        } else {
            false
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct LeafListNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    pub config: Option<ConfigNode>,
    pub type_stmt: Option<TypeNode>,
    pub min_elements: Option<MinElementsNode>,
    pub max_elements: Option<MaxElementsNode>,
    pub unknown: Vec<UnknownNode>,
}

impl LeafListNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ListNode {
    pub name: String,
    pub key: KeyNode,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    pub config: Option<ConfigNode>,
    pub d: DatadefNode,
    pub min_elements: Option<MinElementsNode>,
    pub max_elements: Option<MaxElementsNode>,
    pub must: Vec<MustNode>,
    pub unknown: Vec<UnknownNode>,
}

impl ListNode {
    pub fn new(name: String, key: KeyNode) -> Self {
        Self {
            name,
            key,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct KeyNode {
    pub keys: Vec<String>,
}

impl KeyNode {
    pub fn new(keys: Vec<String>) -> Self {
        Self { keys }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ChoiceNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub status: Option<StatusNode>,
    pub mandatory: Option<MandatoryNode>,
    pub when: Option<WhenNode>,
    pub config: Option<ConfigNode>,
    pub cases: Vec<CaseNode>,
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct WhenNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
}

impl WhenNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

/// A parsed `if-feature` boolean expression (RFC 7950 §7.20.2): a
/// feature reference (possibly prefixed), a negation, or an `and`/`or`
/// of subexpressions. Parentheses in the source collapse into the tree
/// shape and are not represented explicitly.
#[derive(Debug, PartialEq, Clone)]
pub enum IfFeatureExprNode {
    Feature(String),
    Not(Box<IfFeatureExprNode>),
    And(Box<IfFeatureExprNode>, Box<IfFeatureExprNode>),
    Or(Box<IfFeatureExprNode>, Box<IfFeatureExprNode>),
}

/// One `if-feature` statement, carrying its parsed expression. The
/// expression is captured but not yet evaluated — there is no
/// feature-support context in the entry-building pass.
#[derive(Debug, PartialEq, Clone)]
pub struct IfFeatureNode {
    pub expr: IfFeatureExprNode,
}

impl IfFeatureNode {
    pub fn new(expr: IfFeatureExprNode) -> Self {
        Self { expr }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct OrderedByNode {
    pub name: String,
}

impl OrderedByNode {
    pub fn new(name: String) -> Self {
        Self { name }
    }
}

impl ChoiceNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct AnydataNode {
    pub name: String,
    pub description: Option<String>,
}

impl AnydataNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct AnyxmlNode {
    pub name: String,
    pub description: Option<String>,
}

impl AnyxmlNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct UnitsNode {
    pub name: String,
    pub description: Option<String>,
}

impl UnitsNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct MustNode {
    pub name: String,
    pub description: Option<String>,
}

impl MustNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct DefaultNode {
    pub name: String,
    pub description: Option<String>,
}

impl DefaultNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ConfigNode {
    pub config: bool,
}

impl ConfigNode {
    pub fn new(config: bool) -> Self {
        Self { config }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct PresenceNode {
    pub name: String,
    pub description: Option<String>,
}

impl PresenceNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct InputNode {
    pub d: DatadefNode,
}

impl InputNode {
    pub fn new() -> Self {
        Self {
            d: DatadefNode::new(),
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct OutputNode {
    pub d: DatadefNode,
}

impl OutputNode {
    pub fn new() -> Self {
        Self {
            d: DatadefNode::new(),
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ActionNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub status: Option<StatusNode>,
    pub input: Option<InputNode>,
    pub output: Option<OutputNode>,
}

impl ActionNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct CaseNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub status: Option<StatusNode>,
    pub when: Option<WhenNode>,
    pub d: DatadefNode,
}

impl CaseNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct TypeNode {
    pub name: String,
    pub kind: YangType,
    pub description: Option<String>,
    pub pattern: Option<String>,
    pub length: Option<RangeNode>,
    pub range: Option<RangeNode>,
    pub enum_stmt: Vec<EnumNode>,
    pub base: Option<String>,
    pub union: Vec<TypeNode>,
    pub typedef: Option<String>,
    // Populated for YangType::Leafref: the `path "..."` argument from
    // the `leafref` type specification. Survives typedef resolution
    // (typedefs wrapping a leafref carry the underlying path).
    pub path: Option<String>,
}

#[derive(Debug, PartialEq, Clone, Copy, Default, Eq, Hash)]
pub enum YangType {
    #[default]
    Binary,
    Bits,
    Boolean,
    Decimal64,
    Empty,
    Enumeration,
    Int8,
    Int16,
    Int32,
    Int64,
    String,
    Uint8,
    Uint16,
    Uint32,
    Uint64,
    Union,
    Leafref,
    Identityref,
    Path,
    // Extension for zebra.
    Ipv4Addr,
    Ipv4Prefix,
    Ipv6Addr,
    Ipv6Prefix,
    MacAddr,
    NsapAddr,
}

impl TypeNode {
    pub fn new(name: String, kind: YangType) -> Self {
        Self {
            name,
            kind,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct TypedefNode {
    pub name: String,
    pub type_node: Option<TypeNode>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub status: Option<StatusNode>,
}

impl TypedefNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct MandatoryNode {
    pub mandatory: bool,
}

impl MandatoryNode {
    pub fn new(mandatory: bool) -> Self {
        Self { mandatory }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct StatusNode {
    pub status: StatusNodeEnum,
}

#[derive(Debug, PartialEq, Clone, Default)]
pub enum StatusNodeEnum {
    #[default]
    Current,
    Obsolete,
    Deprecated,
}

impl StatusNode {
    pub fn new(status: StatusNodeEnum) -> Self {
        Self { status }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct ExtensionNode {
    pub name: String,
    pub argument: Option<String>,
    pub status: Option<StatusNode>,
    pub description: Option<String>,
    pub reference: Option<String>,
}

impl ExtensionNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct UsesNode {
    pub name: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    /// `augment` substatements (RFC 7950 §7.17, descendant form) that
    /// add nodes to the grouping this `uses` instantiates. Applied
    /// after the grouping is expanded, relative to the instantiation
    /// point.
    pub augment: Vec<AugmentNode>,
    pub d: DatadefNode,
}

impl UsesNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct GroupingNode {
    pub name: String,
    pub status: Option<StatusNode>,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub typedef: Vec<TypedefNode>,
    pub grouping: Vec<GroupingNode>,
    pub d: DatadefNode,
}

/// YANG 1.1 §7.17 `augment` statement. Carries the raw target path
/// string (e.g. "/a:root/a:inner/b:leaf") as written in the module;
/// the entry-building pass splits the segments and resolves prefixes
/// against the augmenting module's imports.
///
/// `when` carries the conditional that, per §7.17, MUST guard an
/// augment that adds mandatory config to another module. `cases` and
/// `action` hold the `case`/`action` substatements allowed when the
/// target is a choice (case) or a container/list (action).
/// `if_feature` holds the parsed `if-feature` expressions (captured but
/// not yet evaluated — there is no feature-support context).
///
/// Not yet modeled: `notification` (no notification node type exists in
/// the AST at all). It is parsed by the grammar and currently dropped.
#[derive(Debug, PartialEq, Clone, Default)]
pub struct AugmentNode {
    pub target: String,
    pub description: Option<String>,
    pub reference: Option<String>,
    pub when: Option<WhenNode>,
    pub status: Option<StatusNode>,
    pub if_feature: Vec<IfFeatureNode>,
    pub cases: Vec<CaseNode>,
    pub action: Vec<ActionNode>,
    pub d: DatadefNode,
}

impl AugmentNode {
    pub fn new(target: String) -> Self {
        Self {
            target,
            ..Default::default()
        }
    }
}

impl GroupingNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct MinElementsNode {
    pub num: u64,
}

impl MinElementsNode {
    pub fn new(num: u64) -> Self {
        Self { num }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct MaxElementsNode {
    pub num: u64,
}

impl MaxElementsNode {
    pub fn new(num: u64) -> Self {
        Self { num }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct EnumNode {
    pub name: String,
}

impl EnumNode {
    pub fn new(name: String) -> Self {
        Self { name }
    }
}

#[derive(Debug, PartialEq, Clone, Default)]
pub struct UnknownNode {
    pub name: String,
    pub argument: String,
}

impl UnknownNode {
    pub fn new(name: String) -> Self {
        Self {
            name,
            ..Default::default()
        }
    }
}