-
-
Notifications
You must be signed in to change notification settings - Fork 18
/
Copy pathrustdoc_schema.graphql
973 lines (800 loc) · 23.2 KB
/
rustdoc_schema.graphql
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
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
schema {
query: RootSchemaQuery
}
directive @filter(op: String!, value: [String!]) on FIELD | INLINE_FRAGMENT
directive @tag(name: String) on FIELD
directive @output(name: String) on FIELD
directive @optional on FIELD
directive @recurse(depth: Int!) on FIELD
directive @fold on FIELD
type RootSchemaQuery {
Crate: Crate!
CrateDiff: CrateDiff!
}
type CrateDiff {
current: Crate!
baseline: Crate
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Crate.html
"""
type Crate {
root: String!
crate_version: String
includes_private: Boolean!
format_version: Int!
"""
The top-level module of the crate, in which everything else in the crate is contained.
"""
root_module: Module!
item: [Item!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
"""
interface Item {
id: String!
crate_id: Int!
name: String
docs: String
"""
A list of all the attributes applied to this item.
The attributes are also available through the `attribute` edge,
which makes certain operations easier.
"""
attrs: [String!]!
# stringified version of the visibility struct field
visibility_limit: String!
attribute: [Attribute!]
span: Span
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.16.0/rustdoc_types/struct.Module.html
"""
type Module implements Item & Importable {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# own properties
is_stripped: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
# own edges
item: [Item!]!
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Struct.html
"""
type Struct implements Item & Importable & ImplOwner {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# own properties
struct_type: String!
fields_stripped: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
# edges from ImplOwner
"""
Any impl for this type.
All impl kinds are included:
- inherent impls: `impl Foo`
- explicit trait implementations: `impl Bar for Foo`
- blanket implementations: `impl<T> Bar for T`
"""
impl: [Impl!]
"""
Only inherent impls: implementations of the type itself (`impl Foo`).
The impls pointed to here are guaranteed to have no `trait` and no `blanket` edges.
This edge is just a convenience to simplify query-writing,
so we don't have to keep writing "@fold @transform(...) @filter(...)" chains
over the `trait` and `blanket` edges.
When Trustfall supports macro edges, this should just become a macro edge.
"""
inherent_impl: [Impl!]
# own edges
field: [StructField!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.Type.html
"""
type StructField implements Item {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# own edges
raw_type: RawType
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Enum.html
"""
type Enum implements Item & Importable & ImplOwner {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# own properties
variants_stripped: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
# edges from ImplOwner
"""
Any impl for this type.
All impl kinds are included:
- inherent impls: `impl Foo`
- explicit trait implementations: `impl Bar for Foo`
- blanket implementations: `impl<T> Bar for T`
"""
impl: [Impl!]
"""
Only inherent impls: implementations of the type itself (`impl Foo`).
The impls pointed to here are guaranteed to have no `trait` and no `blanket` edges.
This edge is just a convenience to simplify query-writing,
so we don't have to keep writing "@fold @transform(...) @filter(...)" chains
over the `trait` and `blanket` edges.
When Trustfall supports macro edges, this should just become a macro edge.
"""
inherent_impl: [Impl!]
# own edges
variant: [Variant!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.Variant.html
"""
interface Variant implements Item {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# own edges
field: [StructField!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.Variant.html
"""
type PlainVariant implements Item & Variant {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Variant
field: [StructField!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.Variant.html
"""
type TupleVariant implements Item & Variant {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Variant
field: [StructField!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.Variant.html
"""
type StructVariant implements Item & Variant {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Variant
field: [StructField!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Span.html
"""
type Span {
filename: String!
begin_line: Int!
begin_column: Int!
end_line: Int!
end_column: Int!
}
"""
An item that can be imported, through one or more paths.
"""
interface Importable {
importable_path: [ImportablePath!]
canonical_path: Path
}
"""
An item that can have impl blocks, like a struct or enum.
"""
interface ImplOwner implements Item & Importable {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
# own edges
"""
Any impl for this type.
All impl kinds are included:
- inherent impls: `impl Foo`
- explicit trait implementations: `impl Bar for Foo`
- blanket implementations: `impl<T> Bar for T`
"""
impl: [Impl!]
"""
Only inherent impls: implementations of the type itself (`impl Foo`).
The impls pointed to here are guaranteed to have no `trait` and no `blanket` edges.
This edge is just a convenience to simplify query-writing,
so we don't have to keep writing "@fold @transform(...) @filter(...)" chains
over the `trait` and `blanket` edges.
When Trustfall supports macro edges, this should just become a macro edge.
"""
inherent_impl: [Impl!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/struct.Impl.html
"""
type Impl implements Item {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
# stringified version of the visibility struct field
visibility_limit: String!
# own properties
unsafe: Boolean!
negative: Boolean!
synthetic: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# own edges
"""
The trait being implemented. Inherent impls don't have a trait.
TODO: implement me
"""
implemented_trait: ImplementedTrait
# """
# The generic type across which the blanket trait implementation is made.
# TODO: implement me
# """
# blanket: GenericType
"""
Methods defined in this impl.
"""
method: [Method!]
"""
Constants associated with this type that are defined in this impl.
"""
associated_constant: [AssociatedConstant!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/struct.Trait.html
"""
type Trait implements Item & Importable {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# own properties
unsafe: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
# own edges
"""
Methods defined in this trait.
"""
method: [Method!]
"""
Traits whose implementation is a prerequisite for implementing this trait.
"""
supertrait: [ImplementedTrait!]
"""
Types associated with the implementation of this trait.
For example: in the `Iterator` trait, `Iterator::Item` is an associated type.
"""
associated_type: [AssociatedType!]
"""
Constants associated with this type that are defined in this impl.
"""
associated_constant: [AssociatedConstant!]
}
"""
A possible way that an item could be imported.
"""
type ImportablePath {
"""
The visibility restriction on this importable path.
For example: "public"
"""
visibility_limit: String!
"""
The path from which the item can be imported.
For example: ["foo", "bar", "Baz"] for a type importable as foo::bar::Baz
"""
path: [String!]!
}
"""
The fully-qualified path of an item including the full sequence of modules in which it is found.
For example, consider a struct `Quux` in `foo/bar/mod.rs`. Its canonical path is `"foo::bar::Quux"`,
even if `foo/mod.rs` might have a line like `pub use bar::Quux;`. The re-export is visible through
the struct's ImportablePath neighbors.
"""
type Path {
path: [String!]!
}
"""
A function-like entity, like a function, function pointer, or method.
Combines:
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Header.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.FnDecl.html
"""
interface FunctionLike {
const: Boolean!
unsafe: Boolean!
async: Boolean!
# own edges
parameter: [FunctionParameter!]
abi: FunctionAbi!
}
"""
A function parameter.
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.FnDecl.html
"""
type FunctionParameter {
name: String!
}
"""
The ABI of a function, method, or function pointer.
It defines the calling convention for those functions, including whether unwinding across
the call boundary is supported. More info: https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html
The list of supported ABIs is here:
https://github.com/rust-lang/rust/blob/557359f92512ca88b62a602ebda291f17a953002/compiler/rustc_target/src/spec/abi.rs#L74-L110
Backed by:
https://docs.rs/rustdoc-types/latest/rustdoc_types/enum.Abi.html
"""
type FunctionAbi {
"""
The name of the ABI, with any `"-unwind"` modifier stripped.
To get the ABI name directly as it would appear in a Rust source file,
use the `raw_name` property instead.
For example, a function defined as `extern "C-unwind" fn example()` would
have `name = "C"` and `raw_name = "C-unwind"`.
Functions with no specified ABI by default have an ABI named `"Rust"`.
"""
name: String!
"""
The raw name of the ABI, as it would appear in a Rust source file.
For example: "C-unwind" or "thiscall-unwind"
Functions with no specified ABI by default have an ABI named `"Rust"`.
"""
raw_name: String!
"""
Whether unwinding across this call is supported.
If encountering an unknown ABI, this value will be `null` due to unknown unwind semantics.
Unwind ability is specified in rustc here:
https://github.com/rust-lang/rust/blob/557359f92512ca88b62a602ebda291f17a953002/compiler/rustc_middle/src/ty/layout.rs#L1422-L1488
More info: https://rust-lang.github.io/rfcs/2945-c-unwind-abi.html
"""
unwind: Boolean
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Function.html
"""
type Function implements Item & FunctionLike & Importable {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# properties from FunctionLike
const: Boolean!
unsafe: Boolean!
async: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from FunctionLike
parameter: [FunctionParameter!]
abi: FunctionAbi!
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Method.html
"""
type Method implements Item & FunctionLike {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# properties from FunctionLike
const: Boolean!
unsafe: Boolean!
async: Boolean!
# edge from Item
span: Span
attribute: [Attribute!]
# edges from FunctionLike
parameter: [FunctionParameter!]
abi: FunctionAbi!
}
"""
Common supertype of `Constant` and `Static`.
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
"""
interface GlobalValue implements Item & Importable {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/struct.Constant.html
"""
type Constant implements Item & Importable & GlobalValue {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# properties for Constant
"""
The expression of the constant, if any, as a Rust literal or `"_"`. For example:
```rust
// // expr
const MIN : usize = 16 ; // 16
const MIN_SIZE: usize = MIN ; // "MIN", referring to the other constant's name
const LOG_AS : &str = "batch" ; // "\"batch\"", including escaped quotes
const YEAR : Years = Years(42); // "_"
const EXPR_2_2: i32 = 2 + 2 ; // "_"
const FN_FIVE : i32 = five() ; // "_"
const fn five() -> i32 { 5 };
struct Years(i32);
```
If the constant is set:
- to be equal to another constant, `expr` holds the name of that other constant.
- by evaluating a `const` expression, such as `2 + 2` or a `const fn` call, `expr` is `"_"` instead of including the full expression.
"""
expr: String
"""
The value of the constant, if any, as a Rust literal. For example:
```rust
// // value
const MIN : usize = 16 ; // "16usize"
const MIN_SIZE: usize = MIN ; // "16usize"
const LOG_AS : &str = "batch" ; // None
const YEAR : Years = Years(42); // None
const EXPR_2_2: i32 = 2 + 2 ; // "4i32"
const FN_FIVE : i32 = five() ; // "5i32"
const fn five() -> i32 { 5 };
struct Years(i32);
```
If the constant is set:
- to be equal to another constant, `value` holds the value of that other constant.
- by evaluating a `const` expression, such as `2 + 2` or a `const fn` call, `value` is evaluated
"""
value: String
"""
The literal flag of the constant. For example:
```rust
// // is_literal
const MIN : usize = 16 ; // true
const MIN_SIZE: usize = MIN ; // false
const LOG_AS : &str = "batch" ; // true
const YEAR : Years = Years(42); // false
const EXPR_2_2: i32 = 2 + 2 ; // false
const FN_FIVE : i32 = five() ; // false
const fn five() -> i32 { 5 };
struct Years(i32);
```
"""
is_literal: Boolean
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/enum.ItemEnum.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/struct.Static.html
"""
type Static implements Item & Importable & GlobalValue {
# properties from Item
id: String!
crate_id: Int!
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# own properties
mutable: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
# edges from Importable
importable_path: [ImportablePath!]
canonical_path: Path
}
"""
A specific attribute applied to an Item.
"""
type Attribute {
"""
String representation of the attribute as it is found in the code.
For example: `#[non_exhaustive]`
"""
raw_attribute: String!
"""
True for an inner attribute (starting with `#![`), and false for an
outer one (starting with `#[`).
For example: false for `#[non_exhaustive]`
"""
is_inner: Boolean!
# edges
# Edge to parsed content of the attribute
content: AttributeMetaItem!
}
"""
A single meta item used by a specific attribute
(see https://doc.rust-lang.org/reference/attributes.html#meta-item-attribute-syntax).
"""
type AttributeMetaItem {
"""
The entire meta item represented as a string as it is found in the code.
For example: `"derive(Debug, Clone)"`
"""
raw_item: String!
"""
SimplePath of the meta item.
For example: `"derive"` for `derive(Debug, Clone)`,
`"must_use"` for `must_use = "example_message"`
"""
base: String!
"""
Assigned item if the meta item is in the form `SimplePath = AssignedItem`.
For example: `"\"example_message\""` for `must_use = "example_message"`
"""
assigned_item: String
# edges
"""
Inner meta items if the meta item is in the form `SimplePath(MetaSeq)`.
For example: `[AttributeMetaItem::new("Debug"), AttributeMetaItem::new("Clone")]`
for `derive(Debug, Clone)`
"""
argument: [AttributeMetaItem!]
}
"""
The trait that is being implemented in an impl block.
In `impl Foo<u64> for Bar`, this is the `Foo<u64>` part.
"""
type ImplementedTrait {
name: String!
# own edges
"""
In `impl Foo<u64> for Bar`, this refers to `trait Foo<T>`.
"""
trait: Trait
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/enum.ItemEnum.html#variant.AssocType
"""
type AssociatedType implements Item {
# properties from Item
id: String!
crate_id: Int!
"""
The name of the associated type.
For example:
```rust
trait Iterator {
type Item; // `"Item"` is the name of the associated type
}
```
"""
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# properties for AssociatedType
"""
Whether the type is defined to have a default value.
For example:
```rust
trait IntIterator {
type Item = i64; // by default, the associated type is `i64` so this property is `true`.
}
```
Associated type defaults are currently unstable: https://github.com/rust-lang/rust/issues/29661
"""
has_default: Boolean!
# edges from Item
span: Span
attribute: [Attribute!]
}
"""
https://docs.rs/rustdoc-types/0.11.0/rustdoc_types/struct.Item.html
https://docs.rs/rustdoc-types/latest/rustdoc_types/enum.ItemEnum.html#variant.AssocConst
"""
type AssociatedConstant implements Item {
# properties from Item
id: String!
crate_id: Int!
"""
The name of the associated constant.
For example:
```rust
trait BatchIterator {
const SIZE: usize; // `"SIZE"` is the name of the associated constant
}
```
"""
name: String
docs: String
attrs: [String!]!
visibility_limit: String!
# properties for AssociatedConstant
"""
The default value of the constant, if any, as a Rust literal, expression, or `"_"`.
For example:
```rust
const fn five() -> i32 { 5 };
struct Years(i32);
trait MyTrait<const MIN: usize> { // rustdocs default field
const NUM : i32 = 16 ; // 16
const MIN_SIZE: usize = MIN ; // "MIN", referring to the other constant's name
const LOG_AS : &'static str = "batch" ; // "\"batch\"", including escaped quotes
const EXPR2_2 : i32 = 2+2 ; // "_"
const FN_FIVE : i32 = five() ; // "_"
const YEAR : Years = Years(42); // "_"
}
```
If the associated constant is on a type's inherent impl, `default` is always required to be set.
If the associated constant is set:
- to be equal to another constant, `default` holds the name of that other constant.
- by evaluating a `const` expression, such as `2 + 2` or a `const fn` call,
`default` is `"_"` instead of evaluating the constant value or including the full expression.
"""
default: String
# edges from Item
span: Span
attribute: [Attribute!]
}
"""
A type represented in the "raw" rustdoc JSON representation.
Copiously detailed, but not the easiest to use due to its complexity.
This interface is a temporary, perma-unstable type intended to be used
only until the rustdoc JSON format is stabilized and until subsequently
we are able to design a better, more permanent representation for
Rust types in this schema.
https://docs.rs/rustdoc-types/latest/rustdoc_types/enum.Type.html
"""
interface RawType {
name: String!
}
"""
Represents a struct, enum, or trait.
https://docs.rs/rustdoc-types/latest/rustdoc_types/enum.Type.html#variant.ResolvedPath
"""
type ResolvedPathType implements RawType {
"""
The fully-qualified canonical name of the type.
For example: "core::marker::PhantomData" or "std::marker::PhantomData"
"""
name: String!
}