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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//! # Enum definitions for a `ComponentInterface`.
//!
//! This module converts enum definition from UDL into structures that can be
//! added to a `ComponentInterface`. A declaration in the UDL like this:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! enum Example {
//! "one",
//! "two"
//! };
//! # "##, "crate_name")?;
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! Will result in a [`Enum`] member being added to the resulting [`crate::ComponentInterface`]:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! # enum Example {
//! # "one",
//! # "two"
//! # };
//! # "##, "crate_name")?;
//! let e = ci.get_enum_definition("Example").unwrap();
//! assert_eq!(e.name(), "Example");
//! assert_eq!(e.variants().len(), 2);
//! assert_eq!(e.variants()[0].name(), "one");
//! assert_eq!(e.variants()[1].name(), "two");
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! Like in Rust, UniFFI enums can contain associated data, but this needs to be
//! declared with a different syntax in order to work within the restrictions of
//! WebIDL. A declaration like this:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! [Enum]
//! interface Example {
//! Zero();
//! One(u32 first);
//! Two(u32 first, string second);
//! };
//! # "##, "crate_name")?;
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! Will result in an [`Enum`] member whose variants have associated fields:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! # [Enum]
//! # interface ExampleWithData {
//! # Zero();
//! # One(u32 first);
//! # Two(u32 first, string second);
//! # };
//! # "##, "crate_name")?;
//! let e = ci.get_enum_definition("ExampleWithData").unwrap();
//! assert_eq!(e.name(), "ExampleWithData");
//! assert_eq!(e.variants().len(), 3);
//! assert_eq!(e.variants()[0].name(), "Zero");
//! assert_eq!(e.variants()[0].fields().len(), 0);
//! assert_eq!(e.variants()[1].name(), "One");
//! assert_eq!(e.variants()[1].fields().len(), 1);
//! assert_eq!(e.variants()[1].fields()[0].name(), "first");
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! # Enums are also used to represent error definitions for a `ComponentInterface`.
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! [Error]
//! enum Example {
//! "one",
//! "two"
//! };
//! # "##, "crate_name")?;
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! Will result in an [`Enum`] member with fieldless variants being added to the resulting [`crate::ComponentInterface`]:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {
//! # [Throws=Example] void func();
//! # };
//! # [Error]
//! # enum Example {
//! # "one",
//! # "two"
//! # };
//! # "##, "crate_name")?;
//! let err = ci.get_enum_definition("Example").unwrap();
//! assert_eq!(err.name(), "Example");
//! assert_eq!(err.variants().len(), 2);
//! assert_eq!(err.variants()[0].name(), "one");
//! assert_eq!(err.variants()[1].name(), "two");
//! assert_eq!(err.is_flat(), true);
//! assert!(ci.is_name_used_as_error(&err.name()));
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! A declaration in the UDL like this:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {};
//! [Error]
//! interface Example {
//! one(i16 code);
//! two(string reason);
//! three(i32 x, i32 y);
//! };
//! # "##, "crate_name")?;
//! # Ok::<(), anyhow::Error>(())
//! ```
//!
//! Will result in an [`Enum`] member with variants that have fields being added to the resulting [`crate::ComponentInterface`]:
//!
//! ```
//! # let ci = uniffi_bindgen::interface::ComponentInterface::from_webidl(r##"
//! # namespace example {
//! # [Throws=Example] void func();
//! # };
//! # [Error]
//! # interface Example {
//! # one();
//! # two(string reason);
//! # three(i32 x, i32 y);
//! # };
//! # "##, "crate_name")?;
//! let err = ci.get_enum_definition("Example").unwrap();
//! assert_eq!(err.name(), "Example");
//! assert_eq!(err.variants().len(), 3);
//! assert_eq!(err.variants()[0].name(), "one");
//! assert_eq!(err.variants()[1].name(), "two");
//! assert_eq!(err.variants()[2].name(), "three");
//! assert_eq!(err.variants()[0].fields().len(), 0);
//! assert_eq!(err.variants()[1].fields().len(), 1);
//! assert_eq!(err.variants()[1].fields()[0].name(), "reason");
//! assert_eq!(err.variants()[2].fields().len(), 2);
//! assert_eq!(err.variants()[2].fields()[0].name(), "x");
//! assert_eq!(err.variants()[2].fields()[1].name(), "y");
//! assert_eq!(err.is_flat(), false);
//! assert!(ci.is_name_used_as_error(err.name()));
//! # Ok::<(), anyhow::Error>(())
//! ```
use anyhow::Result;
use uniffi_meta::Checksum;
use super::record::Field;
use super::{AsType, Literal, Type, TypeIterator};
/// Represents an enum with named variants, each of which may have named
/// and typed fields.
///
/// Enums are passed across the FFI by serializing to a bytebuffer, with a
/// i32 indicating the variant followed by the serialization of each field.
#[derive(Debug, Clone, PartialEq, Eq, Checksum)]
pub struct Enum {
pub(super) name: String,
pub(super) module_path: String,
pub(super) discr_type: Option<Type>,
pub(super) variants: Vec<Variant>,
// NOTE: `flat` is a misleading name and to make matters worse, has 2 different
// meanings depending on the context :(
// * When used as part of Rust scaffolding generation, it means "is this enum
// used with an Error, and that error should we lowered to foreign bindings
// by converting each variant to a string and lowering the variant with that
// string?". In that context, it should probably be called `lowered_as_string` or
// similar.
// * When used as part of bindings generation, it means "does this enum have only
// variants with no associated data"? The foreign binding generators are likely
// to generate significantly different versions of the enum based on that value.
//
// The reason it is described as "has 2 different meanings" by way of example:
// * For an Enum described as being a flat error, but the enum itself has variants with data,
// `flat` will be `true` for the Enum when generating scaffolding and `false` when
// generating bindings.
// * For an Enum not used as an error but which has no variants with data, `flat` will be
// false when generating the scaffolding but `true` when generating bindings.
pub(super) flat: bool,
pub(super) non_exhaustive: bool,
#[checksum_ignore]
pub(super) docstring: Option<String>,
}
impl Enum {
pub fn name(&self) -> &str {
&self.name
}
pub fn variants(&self) -> &[Variant] {
&self.variants
}
// Get the literal value to use for the specified variant's discriminant.
// Follows Rust's rules when mixing specified and unspecified values; please
// file a bug if you find a case where it does not.
// However, it *does not* attempt to handle error cases - either cases where
// a discriminant is not unique, or where a discriminant would overflow the
// repr. The intention is that the Rust compiler itself will fail to build
// in those cases, so by the time this get's run we can be confident these
// error cases can't exist.
pub fn variant_discr(&self, variant_index: usize) -> Result<Literal> {
if variant_index >= self.variants.len() {
anyhow::bail!("Invalid variant index {variant_index}");
}
let mut next = 0;
let mut this;
let mut this_lit = Literal::new_uint(0);
for v in self.variants().iter().take(variant_index + 1) {
(this, this_lit) = match v.discr {
None => (
next,
if (next as i64) < 0 {
Literal::new_int(next as i64)
} else {
Literal::new_uint(next)
},
),
Some(Literal::UInt(v, _, _)) => (v, Literal::new_uint(v)),
// in-practice, Literal::Int == a negative number.
Some(Literal::Int(v, _, _)) => (v as u64, Literal::new_int(v)),
_ => anyhow::bail!("Invalid literal type {v:?}"),
};
next = this.wrapping_add(1);
}
Ok(this_lit)
}
pub fn variant_discr_type(&self) -> &Option<Type> {
&self.discr_type
}
pub fn is_flat(&self) -> bool {
self.flat
}
pub fn is_non_exhaustive(&self) -> bool {
self.non_exhaustive
}
pub fn iter_types(&self) -> TypeIterator<'_> {
Box::new(self.variants.iter().flat_map(Variant::iter_types))
}
pub fn docstring(&self) -> Option<&str> {
self.docstring.as_deref()
}
// Sadly can't use TryFrom due to the 'is_flat' complication.
pub fn try_from_meta(meta: uniffi_meta::EnumMetadata, flat: bool) -> Result<Self> {
// This is messy - error enums are considered "flat" if the user
// opted in via a special attribute, regardless of whether the enum
// is actually flat.
// Real enums are considered flat iff they are actually flat.
// We don't have that context here, so this is handled by our caller.
Ok(Self {
name: meta.name,
module_path: meta.module_path,
discr_type: meta.discr_type,
variants: meta
.variants
.into_iter()
.map(TryInto::try_into)
.collect::<Result<_>>()?,
flat,
non_exhaustive: meta.non_exhaustive,
docstring: meta.docstring.clone(),
})
}
}
impl AsType for Enum {
fn as_type(&self) -> Type {
Type::Enum {
name: self.name.clone(),
module_path: self.module_path.clone(),
}
}
}
/// Represents an individual variant in an Enum.
///
/// Each variant has a name and zero or more fields.
#[derive(Debug, Clone, Default, PartialEq, Eq, Checksum)]
pub struct Variant {
pub(super) name: String,
pub(super) discr: Option<Literal>,
pub(super) fields: Vec<Field>,
#[checksum_ignore]
pub(super) docstring: Option<String>,
}
impl Variant {
pub fn name(&self) -> &str {
&self.name
}
pub fn fields(&self) -> &[Field] {
&self.fields
}
pub fn has_fields(&self) -> bool {
!self.fields.is_empty()
}
pub fn has_nameless_fields(&self) -> bool {
self.fields.iter().any(|f| f.name.is_empty())
}
pub fn docstring(&self) -> Option<&str> {
self.docstring.as_deref()
}
pub fn iter_types(&self) -> TypeIterator<'_> {
Box::new(self.fields.iter().flat_map(Field::iter_types))
}
}
impl TryFrom<uniffi_meta::VariantMetadata> for Variant {
type Error = anyhow::Error;
fn try_from(meta: uniffi_meta::VariantMetadata) -> Result<Self> {
Ok(Self {
name: meta.name,
discr: meta.discr,
fields: meta
.fields
.into_iter()
.map(TryInto::try_into)
.collect::<Result<_>>()?,
docstring: meta.docstring.clone(),
})
}
}
#[cfg(test)]
mod test {
use super::super::{ComponentInterface, FfiType};
use super::*;
#[test]
fn test_duplicate_variants() {
const UDL: &str = r#"
namespace test{};
// Weird, but currently allowed!
// We should probably disallow this...
enum Testing { "one", "two", "one" };
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 1);
assert_eq!(
ci.get_enum_definition("Testing").unwrap().variants().len(),
3
);
}
#[test]
fn test_associated_data() {
const UDL: &str = r#"
namespace test {
void takes_an_enum(TestEnum e);
void takes_an_enum_with_data(TestEnumWithData ed);
TestEnum returns_an_enum();
TestEnumWithData returns_an_enum_with_data();
};
enum TestEnum { "one", "two" };
[Enum]
interface TestEnumWithData {
Zero();
One(u32 first);
Two(u32 first, string second);
};
[Enum]
interface TestEnumWithoutData {
One();
Two();
};
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 3);
assert_eq!(ci.function_definitions().len(), 4);
// The "flat" enum with no associated data.
let e = ci.get_enum_definition("TestEnum").unwrap();
assert!(e.is_flat());
assert_eq!(e.variants().len(), 2);
assert_eq!(
e.variants().iter().map(|v| v.name()).collect::<Vec<_>>(),
vec!["one", "two"]
);
assert_eq!(e.variants()[0].fields().len(), 0);
assert_eq!(e.variants()[1].fields().len(), 0);
// The enum with associated data.
let ed = ci.get_enum_definition("TestEnumWithData").unwrap();
assert!(!ed.is_flat());
assert_eq!(ed.variants().len(), 3);
assert_eq!(
ed.variants().iter().map(|v| v.name()).collect::<Vec<_>>(),
vec!["Zero", "One", "Two"]
);
assert_eq!(ed.variants()[0].fields().len(), 0);
assert_eq!(
ed.variants()[1]
.fields()
.iter()
.map(|f| f.name())
.collect::<Vec<_>>(),
vec!["first"]
);
assert_eq!(
ed.variants()[1]
.fields()
.iter()
.map(|f| f.as_type())
.collect::<Vec<_>>(),
vec![Type::UInt32]
);
assert_eq!(
ed.variants()[2]
.fields()
.iter()
.map(|f| f.name())
.collect::<Vec<_>>(),
vec!["first", "second"]
);
assert_eq!(
ed.variants()[2]
.fields()
.iter()
.map(|f| f.as_type())
.collect::<Vec<_>>(),
vec![Type::UInt32, Type::String]
);
// The enum declared via interface, but with no associated data.
let ewd = ci.get_enum_definition("TestEnumWithoutData").unwrap();
assert_eq!(ewd.variants().len(), 2);
assert_eq!(
ewd.variants().iter().map(|v| v.name()).collect::<Vec<_>>(),
vec!["One", "Two"]
);
assert_eq!(ewd.variants()[0].fields().len(), 0);
assert_eq!(ewd.variants()[1].fields().len(), 0);
// Flat enums pass over the FFI as bytebuffers.
// (It might be nice to optimize these to pass as plain integers, but that's
// difficult atop the current factoring of `ComponentInterface` and friends).
let farg = ci.get_function_definition("takes_an_enum").unwrap();
assert_eq!(
farg.arguments()[0].as_type(),
Type::Enum {
name: "TestEnum".into(),
module_path: "crate_name".into()
}
);
assert_eq!(
farg.ffi_func().arguments()[0].type_(),
FfiType::RustBuffer(None)
);
let fret = ci.get_function_definition("returns_an_enum").unwrap();
assert!(
matches!(fret.return_type(), Some(Type::Enum { name, .. }) if name == "TestEnum" && !ci.is_name_used_as_error(name))
);
assert!(matches!(
fret.ffi_func().return_type(),
Some(FfiType::RustBuffer(None))
));
// Enums with associated data pass over the FFI as bytebuffers.
let farg = ci
.get_function_definition("takes_an_enum_with_data")
.unwrap();
assert_eq!(
farg.arguments()[0].as_type(),
Type::Enum {
name: "TestEnumWithData".into(),
module_path: "crate_name".into()
}
);
assert_eq!(
farg.ffi_func().arguments()[0].type_(),
FfiType::RustBuffer(None)
);
let fret = ci
.get_function_definition("returns_an_enum_with_data")
.unwrap();
assert!(
matches!(fret.return_type(), Some(Type::Enum { name, .. }) if name == "TestEnumWithData" && !ci.is_name_used_as_error(name))
);
assert!(matches!(
fret.ffi_func().return_type(),
Some(FfiType::RustBuffer(None))
));
}
// Tests for [Error], which are represented as `Enum`
#[test]
fn test_variants() {
const UDL: &str = r#"
namespace test{
[Throws=Testing]
void func();
};
[Error]
enum Testing { "one", "two", "three" };
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 1);
let error = ci.get_enum_definition("Testing").unwrap();
assert_eq!(
error
.variants()
.iter()
.map(|v| v.name())
.collect::<Vec<&str>>(),
vec!("one", "two", "three")
);
assert!(error.is_flat());
assert!(ci.is_name_used_as_error(&error.name));
}
#[test]
fn test_duplicate_error_variants() {
const UDL: &str = r#"
namespace test{};
// Weird, but currently allowed!
// We should probably disallow this...
[Error]
enum Testing { "one", "two", "one" };
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 1);
assert_eq!(
ci.get_enum_definition("Testing").unwrap().variants().len(),
3
);
}
#[test]
fn test_variant_data() {
const UDL: &str = r#"
namespace test{
[Throws=Testing]
void func();
};
[Error]
interface Testing {
One(string reason);
Two(u8 code);
};
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 1);
let error: &Enum = ci.get_enum_definition("Testing").unwrap();
assert_eq!(
error
.variants()
.iter()
.map(|v| v.name())
.collect::<Vec<&str>>(),
vec!("One", "Two")
);
assert!(!error.is_flat());
assert!(ci.is_name_used_as_error(&error.name));
}
#[test]
fn test_enum_variant_named_error() {
const UDL: &str = r#"
namespace test{};
[Enum]
interface Testing {
Normal(string first);
Error(string first);
};
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(ci.enum_definitions().count(), 1);
let testing: &Enum = ci.get_enum_definition("Testing").unwrap();
assert_eq!(
testing.variants()[0]
.fields()
.iter()
.map(|f| f.name())
.collect::<Vec<_>>(),
vec!["first"]
);
assert_eq!(
testing.variants()[0]
.fields()
.iter()
.map(|f| f.as_type())
.collect::<Vec<_>>(),
vec![Type::String]
);
assert_eq!(
testing.variants()[1]
.fields()
.iter()
.map(|f| f.name())
.collect::<Vec<_>>(),
vec!["first"]
);
assert_eq!(
testing.variants()[1]
.fields()
.iter()
.map(|f| f.as_type())
.collect::<Vec<_>>(),
vec![Type::String]
);
assert_eq!(
testing
.variants()
.iter()
.map(|v| v.name())
.collect::<Vec<_>>(),
vec!["Normal", "Error"]
);
}
fn variant(val: Option<u64>) -> Variant {
Variant {
name: "v".to_string(),
discr: val.map(Literal::new_uint),
fields: vec![],
docstring: None,
}
}
fn check_discrs(e: &mut Enum, vs: Vec<Variant>) -> Vec<u64> {
e.variants = vs;
(0..e.variants.len())
.map(|i| e.variant_discr(i).unwrap())
.map(|l| match l {
Literal::UInt(v, _, _) => v,
_ => unreachable!(),
})
.collect()
}
#[test]
fn test_variant_values() {
let mut e = Enum {
module_path: "test".to_string(),
name: "test".to_string(),
discr_type: None,
variants: vec![],
flat: false,
non_exhaustive: false,
docstring: None,
};
assert!(e.variant_discr(0).is_err());
// single values
assert_eq!(check_discrs(&mut e, vec![variant(None)]), vec![0]);
assert_eq!(check_discrs(&mut e, vec![variant(Some(3))]), vec![3]);
// no values
assert_eq!(
check_discrs(&mut e, vec![variant(None), variant(None)]),
vec![0, 1]
);
// values
assert_eq!(
check_discrs(&mut e, vec![variant(Some(1)), variant(Some(3))]),
vec![1, 3]
);
// mixed values
assert_eq!(
check_discrs(&mut e, vec![variant(None), variant(Some(3)), variant(None)]),
vec![0, 3, 4]
);
assert_eq!(
check_discrs(
&mut e,
vec![variant(Some(4)), variant(None), variant(Some(1))]
),
vec![4, 5, 1]
);
}
#[test]
fn test_docstring_enum() {
const UDL: &str = r#"
namespace test{};
/// informative docstring
enum Testing { "foo" };
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(
ci.get_enum_definition("Testing")
.unwrap()
.docstring()
.unwrap(),
"informative docstring"
);
}
#[test]
fn test_docstring_enum_variant() {
const UDL: &str = r#"
namespace test{};
enum Testing {
/// informative docstring
"foo"
};
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(
ci.get_enum_definition("Testing").unwrap().variants()[0]
.docstring()
.unwrap(),
"informative docstring"
);
}
#[test]
fn test_docstring_associated_enum() {
const UDL: &str = r#"
namespace test{};
/// informative docstring
[Enum]
interface Testing { };
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(
ci.get_enum_definition("Testing")
.unwrap()
.docstring()
.unwrap(),
"informative docstring"
);
}
#[test]
fn test_docstring_associated_enum_variant() {
const UDL: &str = r#"
namespace test{};
[Enum]
interface Testing {
/// informative docstring
testing();
};
"#;
let ci = ComponentInterface::from_webidl(UDL, "crate_name").unwrap();
assert_eq!(
ci.get_enum_definition("Testing").unwrap().variants()[0]
.docstring()
.unwrap(),
"informative docstring"
);
}
}
|