forked from SchemaStore/schemastore
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cargo.json
1845 lines (1845 loc) · 130 KB
/
cargo.json
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
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://json.schemastore.org/cargo.json",
"definitions": {
"Build": {
"title": "Build",
"description": "The `build` field specifies a file in the package root which is a [build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) for building native code. More information can be found in the [build script guide](https://doc.rust-lang.org/cargo/reference/build-scripts.html).\n\n\n```toml\n[package]\n# ...\nbuild = \"build.rs\"\n```\n\nThe default is `\"build.rs\"`, which loads the script from a file named\n`build.rs` in the root of the package. Use `build = \"custom_build_name.rs\"` to\nspecify a path to a different file or `build = false` to disable automatic\ndetection of the build script.\n",
"anyOf": [
{
"description": "Path to the build file.",
"type": "string"
},
{
"type": "boolean",
"enum": [true, false],
"x-taplo": {
"docs": {
"enumValues": [
"Automatically detect the build file (`build.rs`).",
"Disable automatic detection of the build file."
]
}
}
}
],
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-build-field"
}
}
},
"DebugLevel": {
"title": "Debug Level",
"description": "The `debug` setting controls the [`-C debuginfo` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#debuginfo) which controls the\namount of debug information included in the compiled binary.",
"enum": [
0,
1,
2,
true,
false,
"none",
"line-directives-only",
"line-tables-only",
"limited",
"full"
],
"x-taplo": {
"docs": {
"enumValues": [
"No debug info at all, default for `release` profile",
"Debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.",
"Full debug info, default for `dev` profile",
"Full debug info, default for `dev` profile",
"No debug info at all, default for `release` profile",
"No debug info at all, default for `release` profile",
"Line info directives only. For the nvptx* targets this enables [profiling](https://reviews.llvm.org/D46061). For other use cases, `line-tables-only` is the better, more compatible choice.",
"Line tables only. Generates the minimal amount of debug info for backtraces with filename/line number info, but not anything else, i.e. no variable or function parameter info.",
"Debug info without type or variable-level information. Generates more detailed module-level info than `line-tables-only`.",
"Full debug info, default for `dev` profile"
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#debug"
}
}
},
"Dependency": {
"title": "Dependency",
"anyOf": [
{
"$ref": "#/definitions/SemVerRequirement"
},
{
"$ref": "#/definitions/DetailedDependency"
}
]
},
"DetailedDependency": {
"title": "Detailed Dependency",
"type": "object",
"properties": {
"branch": {
"description": "Specify the Git branch to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"
}
}
},
"default-features": {
"description": "Use the default features of the dependency.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"
}
}
},
"default_features": {
"type": "boolean",
"x-taplo": {
"hidden": true
}
},
"features": {
"description": "List of features to activate in the dependency.",
"type": "array",
"items": {
"description": "List of features to activate in the dependency.",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"
},
"plugins": ["crates"],
"crates": {
"schemas": "feature"
}
}
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"
}
}
},
"git": {
"description": "To depend on a library located in a `git` repository, the minimum information\nyou need to specify is the location of the repository with the `git` key:\n\n```toml\n[dependencies]\nrand = { git = \"https://github.com/rust-lang-nursery/rand\" }\n```\n\nCargo will fetch the `git` repository at this location then look for a\n`Cargo.toml` for the requested crate anywhere inside the `git` repository\n(not necessarily at the root - for example, specifying a member crate name\nof a workspace and setting `git` to the repository containing the workspace).\n\nSince we haven't specified any other information, Cargo assumes that\nwe intend to use the latest commit on the main branch to build our package.\nYou can combine the `git` key with the `rev`, `tag`, or `branch` keys to\nspecify something else. Here's an example of specifying that you want to use\nthe latest commit on a branch named `next`:\n\n```toml\n[dependencies]\nrand = { git = \"https://github.com/rust-lang-nursery/rand\", branch = \"next\" }\n```\n\nSee [Git Authentication](https://doc.rust-lang.org/cargo/appendix/git-authentication.html) for help with git authentication for private repos.\n\n> **Note**: [crates.io](https://crates.io/) does not allow packages to be published with `git`\n> dependencies (`git` [dev-dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies) are ignored). See the [Multiple\n> locations](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations) section for a fallback alternative.\n",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"
}
}
},
"optional": {
"description": "Mark the dependency as optional.\n\nOptional dependencies can be activated through features.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"
}
}
},
"package": {
"description": "Specify the name of the package.\n\nWhen writing a `[dependencies]` section in `Cargo.toml` the key you write for a\ndependency typically matches up to the name of the crate you import from in the\ncode. For some projects, though, you may wish to reference the crate with a\ndifferent name in the code regardless of how it's published on crates.io. For\nexample you may wish to:\n\n* Avoid the need to `use foo as bar` in Rust source.\n* Depend on multiple versions of a crate.\n* Depend on crates with the same name from different registries.\n\nTo support this Cargo supports a `package` key in the `[dependencies]` section\nof which package should be depended on:\n\n```toml\n[package]\nname = \"mypackage\"\nversion = \"0.0.1\"\n\n[dependencies]\nfoo = \"0.1\"\nbar = { git = \"https://github.com/example/project\", package = \"foo\" }\nbaz = { version = \"0.1\", registry = \"custom\", package = \"foo\" }\n```\n\nIn this example, three crates are now available in your Rust code:\n\n```rust\nextern crate foo; // crates.io\nextern crate bar; // git repository\nextern crate baz; // registry `custom`\n```\n\nAll three of these crates have the package name of `foo` in their own\n`Cargo.toml`, so we're explicitly using the `package` key to inform Cargo that\nwe want the `foo` package even though we're calling it something else locally.\nThe `package` key, if not specified, defaults to the name of the dependency\nbeing requested.\n",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml"
}
}
},
"path": {
"description": "Cargo supports **path dependencies** which are typically sub-crates that live within one repository.\nLet's start off by making a new crate inside of our `hello_world` package:\n\n```console\n# inside of hello_world/\n$ cargo new hello_utils\n```\n\nThis will create a new folder `hello_utils` inside of which a `Cargo.toml` and\n`src` folder are ready to be configured. In order to tell Cargo about this, open\nup `hello_world/Cargo.toml` and add `hello_utils` to your dependencies:\n\n```toml\n[dependencies]\nhello_utils = { path = \"hello_utils\" }\n```\n\nThis tells Cargo that we depend on a crate called `hello_utils` which is found\nin the `hello_utils` folder (relative to the `Cargo.toml` it's written in).",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies"
}
}
},
"public": {
"type": "boolean",
"x-taplo": {
"hidden": true
}
},
"registry": {
"description": "To specify a dependency from a registry other than [crates.io](https://crates.io), first the\nregistry must be configured in a `.cargo/config.toml` file. See the [registries\ndocumentation](https://doc.rust-lang.org/cargo/reference/registries.html) for more information. In the dependency, set the `registry` key\nto the name of the registry to use.\n\n```toml\n[dependencies]\nsome-crate = { version = \"1.0\", registry = \"my-registry\" }\n```\n\n> **Note**: [crates.io](https://crates.io) does not allow packages to be published with\n> dependencies on other registries.\n",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-other-registries"
}
}
},
"registry-index": {
"type": "string",
"x-taplo": {
"hidden": true
}
},
"rev": {
"description": "Specify the Git revision to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"
}
}
},
"tag": {
"description": "Specify the Git tag to use in case of a [Git dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories).",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"
}
}
},
"version": {
"$ref": "#/definitions/SemVerRequirement"
}
},
"x-taplo": {
"initFields": ["version"]
}
},
"Edition": {
"title": "Edition",
"description": "The `edition` key affects which edition your package is compiled with. Cargo\nwill always generate packages via [`cargo new`](https://doc.rust-lang.org/cargo/commands/cargo-new.html) with the `edition` key set to the\nlatest edition. Setting the `edition` key in `[package]` will affect all\ntargets/crates in the package, including test suites, benchmarks, binaries,\nexamples, etc.",
"type": "string",
"enum": ["2015", "2018", "2021", "2024"],
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/stable/edition-guide/introduction.html"
}
}
},
"Lto": {
"title": "Lto",
"description": "The `lto` setting controls the [`-C lto` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#lto) which controls LLVM's [link time optimizations](https://llvm.org/docs/LinkTimeOptimization.html). LTO can produce better optimized code, using\nwhole-program analysis, at the cost of longer linking time.\n \nSee also the [`-C linker-plugin-lto`](https://doc.rust-lang.org/rustc/codegen-options/index.html#linker-plugin-lto) `rustc` flag for cross-language LTO.",
"enum": ["fat", "thin", "off", true, false],
"x-taplo": {
"docs": {
"enumValues": [
"Performs \"fat\" LTO which attempts to perform optimizations across all crates within the dependency graph.",
"Performs [\"thin\" LTO](http://blog.llvm.org/2016/06/thinlto-scalable-and-incremental-lto.html). This is similar to \"fat\", but takes\nsubstantially less time to run while still achieving performance gains\nsimilar to \"fat\".",
"Disables LTO.",
"Performs \"fat\" LTO which attempts to perform optimizations across all crates within the dependency graph.",
"Performs \"thin local LTO\" which performs \"thin\" LTO on the local\ncrate only across its [codegen units](https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units). No LTO is performed\nif codegen units is 1 or [opt-level](https://doc.rust-lang.org/cargo/reference/profiles.html#opt-level) is 0."
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#lto"
}
}
},
"MetaBuild": {
"title": "Meta Build",
"type": "array",
"items": {
"type": "string"
}
},
"Resolver": {
"title": "Resolver",
"description": "A different feature resolver algorithm can be used by specifying the resolver version in Cargo.toml like this:\n\n[package]\nname = \"my-package\"\nversion = \"1.0.0\"\nresolver = \"2\"\n\nThe version \"1\" resolver is the original resolver that shipped with Cargo up to version 1.50. The default is \"2\" if the root package specifies edition = \"2021\" or a newer edition. Otherwise the default is \"1\".\n\nThe version \"2\" resolver introduces changes in feature unification. See the features chapter for more details.\n\nThe resolver is a global option that affects the entire workspace. The resolver version in dependencies is ignored, only the value in the top-level package will be used. If using a virtual workspace, the version should be specified in the [workspace] table, for example:\n\n[workspace]\nmembers = [\"member1\", \"member2\"]\nresolver = \"2\"",
"type": "string",
"enum": ["1", "2"],
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions"
}
}
},
"OptLevel": {
"title": "Optimization Level",
"description": "The `opt-level` setting controls the [`-C opt-level` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#opt-level) which controls the level\nof optimization. Higher optimization levels may produce faster runtime code at\nthe expense of longer compiler times. Higher levels may also change and\nrearrange the compiled code which may make it harder to use with a debugger.\n\nIt is recommended to experiment with different levels to find the right\nbalance for your project. There may be surprising results, such as level `3`\nbeing slower than `2`, or the `\"s\"` and `\"z\"` levels not being necessarily\nsmaller. You may also want to reevaluate your settings over time as newer\nversions of `rustc` changes optimization behavior.\n\nSee also [Profile Guided Optimization](https://doc.rust-lang.org/rustc/profile-guided-optimization.html) for more advanced optimization\ntechniques.",
"enum": [0, 1, 2, 3, "s", "z"],
"x-taplo": {
"docs": {
"enumValues": [
"No optimizations, also turns on [`cfg(debug_assertions)`](https://doc.rust-lang.org/cargo/reference/profiles.html#debug-assertions).",
"Basic optimizations.",
"Some optimizations.",
"All optimizations.",
"Optimize for binary size.",
"Optimize for binary size, but also turn off loop vectorization."
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#opt-level"
}
}
},
"Package": {
"title": "Package",
"description": "The only field required by Cargo is [`name`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field).\n If publishing to a registry, the registry may\nrequire additional fields. See the notes below and [the publishing chapter](https://doc.rust-lang.org/cargo/reference/publishing.html) for requirements for publishing to [crates.io](https://crates.io/).",
"type": "object",
"required": ["name"],
"properties": {
"authors": {
"anyOf": [
{
"$ref": "#/definitions/Authors"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"autobenches": {
"description": "Disable automatic discovery of `bench` targets.\n\nDisabling automatic discovery should only be needed for specialized\nsituations. For example, if you have a library where you want a *module* named\n`bin`, this would present a problem because Cargo would usually attempt to\ncompile anything in the `bin` directory as an executable. Here is a sample\nlayout of this scenario:\n\n```\n├── Cargo.toml\n└── src\n ├── lib.rs\n └── bin\n └── mod.rs\n```\n",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"
}
}
},
"autobins": {
"description": "Disable automatic discovery of `bin` targets.\n\nDisabling automatic discovery should only be needed for specialized\nsituations. For example, if you have a library where you want a *module* named\n`bin`, this would present a problem because Cargo would usually attempt to\ncompile anything in the `bin` directory as an executable. Here is a sample\nlayout of this scenario:\n\n```\n├── Cargo.toml\n└── src\n ├── lib.rs\n └── bin\n └── mod.rs\n```\n\nTo prevent Cargo from inferring `src/bin/mod.rs` as an executable, set\nthis to `false` to disable auto-discovery.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"
}
}
},
"autoexamples": {
"description": "Disable automatic discovery of `example` targets.\n\nDisabling automatic discovery should only be needed for specialized\nsituations. For example, if you have a library where you want a *module* named\n`bin`, this would present a problem because Cargo would usually attempt to\ncompile anything in the `bin` directory as an executable. Here is a sample\nlayout of this scenario:\n\n```\n├── Cargo.toml\n└── src\n ├── lib.rs\n └── bin\n └── mod.rs\n```\n",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"
}
}
},
"autotests": {
"description": "Disable automatic discovery of `test` targets.\n\nDisabling automatic discovery should only be needed for specialized\nsituations. For example, if you have a library where you want a *module* named\n`bin`, this would present a problem because Cargo would usually attempt to\ncompile anything in the `bin` directory as an executable. Here is a sample\nlayout of this scenario:\n\n```\n├── Cargo.toml\n└── src\n ├── lib.rs\n └── bin\n └── mod.rs\n```\n",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"
}
}
},
"build": {
"$ref": "#/definitions/Build"
},
"categories": {
"anyOf": [
{
"$ref": "#/definitions/Categories"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"default-run": {
"description": "The `default-run` field in the `[package]` section of the manifest can be used\nto specify a default binary picked by [`cargo run`](https://doc.rust-lang.org/cargo/commands/cargo-run.html). For example, when there is\nboth `src/bin/a.rs` and `src/bin/b.rs`:\n\n```toml\n[package]\ndefault-run = \"a\"\n```",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-default-run-field"
}
}
},
"description": {
"anyOf": [
{
"$ref": "#/definitions/Description"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"documentation": {
"anyOf": [
{
"$ref": "#/definitions/Documentation"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"edition": {
"anyOf": [
{
"$ref": "#/definitions/Edition"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"exclude": {
"anyOf": [
{
"$ref": "#/definitions/Exclude"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"homepage": {
"anyOf": [
{
"$ref": "#/definitions/Homepage"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"im-a-teapot": {
"description": "Sets whether the current package is a teapot or something else that is not capable of brewing tea.",
"type": "boolean",
"x-taplo": {
"hidden": true
}
},
"include": {
"anyOf": [
{
"$ref": "#/definitions/Include"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"keywords": {
"anyOf": [
{
"$ref": "#/definitions/Keywords"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"license": {
"anyOf": [
{
"$ref": "#/definitions/License"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"license-file": {
"anyOf": [
{
"$ref": "#/definitions/LicenseFile"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"links": {
"description": "The `links` field specifies the name of a native library that is being linked\nto. More information can be found in the [`links`](https://doc.rust-lang.org/cargo/reference/build-scripts.html#the-links-manifest-key) section of the build\nscript guide.\n\n```toml\n[package]\n# ...\nlinks = \"foo\"\n```",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-links-field"
}
}
},
"metabuild": {
"$ref": "#/definitions/MetaBuild",
"x-taplo": {
"hidden": true
}
},
"metadata": {
"description": "Cargo by default will warn about unused keys in `Cargo.toml` to assist in\ndetecting typos and such. The `package.metadata` table, however, is completely\nignored by Cargo and will not be warned about. This section can be used for\ntools which would like to store package configuration in `Cargo.toml`. For\nexample:\n\n```toml\n[package]\nname = \"...\"\n# ...\n\n# Metadata used when generating an Android APK, for example.\n[package.metadata.android]\npackage-name = \"my-awesome-android-app\"\nassets = \"path/to/static\"\n```\n",
"type": "object",
"additionalProperties": true,
"properties": {
"playdate": {
"$ref": "#/definitions/PlaydateMetadata"
}
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-metadata-table"
}
}
},
"name": {
"description": "The package name is an identifier used to refer to the package. It is used\nwhen listed as a dependency in another package, and as the default name of\ninferred lib and bin targets.\n\nThe name must use only [alphanumeric](https://doc.rust-lang.org/std/primitive.char.html#method.is_alphanumeric) characters or `-` or `_`, and cannot be empty.\nNote that [`cargo new`](https://doc.rust-lang.org/cargo/commands/cargo-new.html) and [`cargo init`](https://doc.rust-lang.org/cargo/commands/cargo-init.html) impose some additional restrictions on\nthe package name, such as enforcing that it is a valid Rust identifier and not\na keyword. [crates.io](https://crates.io) imposes even more restrictions, such as\nenforcing only ASCII characters, not a reserved name, not a special Windows\nname such as \"nul\", is not too long, etc.",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field"
}
}
},
"namespaced-features": {
"type": "boolean",
"x-taplo": {
"hidden": true
}
},
"publish": {
"anyOf": [
{
"$ref": "#/definitions/Publish"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"publish-lockfile": {
"type": "boolean",
"x-taplo": {
"hidden": true
}
},
"readme": {
"anyOf": [
{
"$ref": "#/definitions/Readme"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"repository": {
"anyOf": [
{
"$ref": "#/definitions/Repository"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"resolver": {
"$ref": "#/definitions/Resolver"
},
"rust-version": {
"anyOf": [
{
"$ref": "#/definitions/RustVersion"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"version": {
"anyOf": [
{
"$ref": "#/definitions/SemVer"
},
{
"$ref": "#/definitions/WorkspaceInheritance"
}
]
},
"workspace": {
"description": "The `workspace` field can be used to configure the workspace that this package\nwill be a member of. If not specified this will be inferred as the first\nCargo.toml with `[workspace]` upwards in the filesystem. Setting this is\nuseful if the member is not inside a subdirectory of the workspace root.\n\n```toml\n[package]\n# ...\nworkspace = \"path/to/workspace/root\"\n```\n\nThis field cannot be specified if the manifest already has a `[workspace]`\ntable defined. That is, a crate cannot both be a root crate in a workspace\n(contain `[workspace]`) and also be a member crate of another workspace\n(contain `package.workspace`).\n\nFor more information, see the [workspaces chapter](https://doc.rust-lang.org/cargo/reference/workspaces.html).",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-workspace-field"
}
}
}
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-package-section"
}
}
},
"Panic": {
"title": "Panic",
"description": "The `panic` setting controls the [`-C panic` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#panic) which controls which panic\nstrategy to use.\n\nWhen set to `\"unwind\"`, the actual value depends on the default of the target\nplatform. For example, the NVPTX platform does not support unwinding, so it\nalways uses `\"abort\"`.\n\nTests, benchmarks, build scripts, and proc macros ignore the `panic` setting.\nThe `rustc` test harness currently requires `unwind` behavior. See the\n[`panic-abort-tests`](https://doc.rust-lang.org/cargo/reference/unstable.html#panic-abort-tests) unstable flag which enables `abort` behavior.\n\nAdditionally, when using the `abort` strategy and building a test, all of the\ndependencies will also be forced to built with the `unwind` strategy.",
"type": "string",
"enum": ["unwind", "abort"],
"x-taplo": {
"docs": {
"enumValues": [
"Unwind the stack upon panic.",
"Terminate the process upon panic."
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#panic"
}
}
},
"Platform": {
"title": "Platform",
"type": "object",
"properties": {
"build-dependencies": {
"description": "You can depend on other Cargo-based crates for use in your build scripts.\nDependencies are declared through the `build-dependencies` section of the\nmanifest:\n\n```toml\n[build-dependencies]\ncc = \"1.0.3\"\n```\n\nThe build script **does not** have access to the dependencies listed\nin the `dependencies` or `dev-dependencies` section. Build\ndependencies will likewise not be available to the package itself\nunless listed under the `dependencies` section as well. A package\nitself and its build script are built separately, so their\ndependencies need not coincide. Cargo is kept simpler and cleaner by\nusing independent dependencies for independent purposes.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Dependency"
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#build-dependencies"
},
"plugins": ["crates"],
"crates": {
"schemas": "dependencies"
}
}
},
"build_dependencies": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Dependency"
},
"x-taplo": {
"hidden": true
}
},
"dependencies": {
"description": "Cargo is configured to look for dependencies on [crates.io](https://crates.io) by default. Only\nthe name and a version string are required in this case. In [the cargo\nguide](https://doc.rust-lang.org/cargo/guide/index.html), we specified a dependency on the `time` crate:\n\n```toml\n[dependencies]\ntime = \"0.1.12\"\n```\n\nThe string `\"0.1.12\"` is a [semver](https://github.com/steveklabnik/semver#requirements) version requirement. Since this\nstring does not have any operators in it, it is interpreted the same way as\nif we had specified `\"^0.1.12\"`, which is called a caret requirement.\n\nA dependency can also be defined by a table with additional options:\n\n```toml\n[dependencies]\ntime = { path = \"../time\", version = \"0.1.12\" }\n```",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Dependency"
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"
}
}
},
"dev-dependencies": {
"description": "The format of `[dev-dependencies]` is equivalent to `[dependencies]`:\n\n```toml\n[dev-dependencies]\ntempdir = \"0.3\"\n```\n\nDev-dependencies are not used when compiling\na package for building, but are used for compiling tests, examples, and\nbenchmarks.\n\nThese dependencies are *not* propagated to other packages which depend on this\npackage.\n\nYou can also have target-specific development dependencies by using\n`dev-dependencies` in the target section header instead of `dependencies`. For\nexample:\n\n```toml\n[target.'cfg(unix)'.dev-dependencies]\nmio = \"0.0.1\"\n```\n\n> **Note**: When a package is published, only dev-dependencies that specify a\n> `version` will be included in the published crate. For most use cases,\n> dev-dependencies are not needed when published, though some users (like OS\n> packagers) may want to run tests within a crate, so providing a `version` if\n> possible can still be beneficial.\n",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Dependency"
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies"
},
"plugins": ["crates"],
"crates": {
"schemas": "dependencies"
}
}
},
"dev_dependencies": {
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Dependency"
},
"x-taplo": {
"hidden": true
}
}
}
},
"BuildOverride": {
"title": "Build Override",
"type": "object",
"description": "Profile settings can be overridden for specific packages and build-time\ncrates. To override the settings for a specific package, use the `package`\ntable to change the settings for the named package:\n\n```toml\n# The `foo` package will use the -Copt-level=3 flag.\n[profile.dev.package.foo]\nopt-level = 3\n```\n\nThe package name is actually a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can\ntarget individual versions of a package with syntax such as\n`[profile.dev.package.\"foo:2.1.0\"]`.\n\nTo override the settings for all dependencies (but not any workspace member),\nuse the `\"*\"` package name:\n\n```toml\n# Set the default for dependencies.\n[profile.dev.package.\"*\"]\nopt-level = 2\n```\n\nTo override the settings for build scripts, proc macros, and their\ndependencies, use the `build-override` table:\n\n```toml\n# Set the settings for build scripts and proc-macros.\n[profile.dev.build-override]\nopt-level = 3\n```\n\n> Note: When a dependency is both a normal dependency and a build dependency,\n> Cargo will try to only build it once when `--target` is not specified. When\n> using `build-override`, the dependency may need to be built twice, once as a\n> normal dependency and once with the overridden build settings. This may\n> increase initial build times.\n",
"allOf": [
{
"$ref": "#/definitions/Profile"
}
],
"x-taplo": {
"docs": {
"main": "Profile settings can be overridden for specific packages and build-time\ncrates. To override the settings for a specific package, use the `package`\ntable to change the settings for the named package:\n\n```toml\n# The `foo` package will use the -Copt-level=3 flag.\n[profile.dev.package.foo]\nopt-level = 3\n```\n\nThe package name is actually a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can\ntarget individual versions of a package with syntax such as\n`[profile.dev.package.\"foo:2.1.0\"]`.\n\nTo override the settings for all dependencies (but not any workspace member),\nuse the `\"*\"` package name:\n\n```toml\n# Set the default for dependencies.\n[profile.dev.package.\"*\"]\nopt-level = 2\n```\n\nTo override the settings for build scripts, proc macros, and their\ndependencies, use the `build-override` table:\n\n```toml\n# Set the settings for build scripts and proc-macros.\n[profile.dev.build-override]\nopt-level = 3\n```\n\n> Note: When a dependency is both a normal dependency and a build dependency,\n> Cargo will try to only build it once when `--target` is not specified. When\n> using `build-override`, the dependency may need to be built twice, once as a\n> normal dependency and once with the overridden build settings. This may\n> increase initial build times.\n"
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overrides"
}
}
},
"ProfileWithBuildOverride": {
"allOf": [
{
"$ref": "#/definitions/Profile"
},
{
"type": "object",
"properties": {
"build-override": {
"$ref": "#/definitions/Profile"
}
}
}
]
},
"Profile": {
"title": "Profile",
"type": "object",
"properties": {
"codegen-units": {
"description": "The `codegen-units` setting controls the [`-C codegen-units` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units) which\ncontrols how many \"code generation units\" a crate will be split into. More\ncode generation units allows more of a crate to be processed in parallel\npossibly reducing compile time, but may produce slower code.\n\nThis option takes an integer greater than 0.\n\nThe default is 256 for [incremental](https://doc.rust-lang.org/cargo/reference/profiles.html#incremental) builds, and 16 for\nnon-incremental builds.",
"type": "integer",
"format": "uint32",
"minimum": 0,
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units"
}
}
},
"debug": {
"$ref": "#/definitions/DebugLevel"
},
"debug-assertions": {
"description": "The `debug-assertions` setting controls the [`-C debug-assertions` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#debug-assertions) which\nturns `cfg(debug_assertions)` [conditional compilation](https://doc.rust-lang.org/reference/conditional-compilation.html#debug_assertions) on or off. Debug\nassertions are intended to include runtime validation which is only available\nin debug/development builds. These may be things that are too expensive or\notherwise undesirable in a release build. Debug assertions enables the\n[`debug_assert!` macro](https://doc.rust-lang.org/std/macro.debug_assert.html) in the standard library.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#debug-assertions"
}
}
},
"dir-name": {
"type": "string",
"x-taplo": {
"hidden": true
}
},
"incremental": {
"description": "The `incremental` setting controls the [`-C incremental` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#incremental) which controls\nwhether or not incremental compilation is enabled. Incremental compilation\ncauses `rustc` to to save additional information to disk which will be reused\nwhen recompiling the crate, improving re-compile times. The additional\ninformation is stored in the `target` directory.\n\nThe valid options are:\n\n* `true`: enabled\n* `false`: disabled\n\nIncremental compilation is only used for workspace members and \"path\"\ndependencies.\n\nThe incremental value can be overridden globally with the `CARGO_INCREMENTAL`\n[environment variable](https://doc.rust-lang.org/cargo/reference/environment-variables.html) or the [`build.incremental`](https://doc.rust-lang.org/cargo/reference/config.html#buildincremental) config variable.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#incremental"
}
}
},
"inherits": {
"type": "string",
"x-taplo": {
"hidden": true
}
},
"lto": {
"$ref": "#/definitions/Lto"
},
"opt-level": {
"$ref": "#/definitions/OptLevel"
},
"overflow-checks": {
"description": "The `overflow-checks` setting controls the [`-C overflow-checks` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#overflow-checks) which\ncontrols the behavior of [runtime integer overflow](https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow). When overflow-checks are\nenabled, a panic will occur on overflow.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overflow-checks"
}
}
},
"package": {
"description": "Package-specific overrides.\n\nThe package name is a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can\ntarget individual versions of a package with syntax such as `[profile.dev.package.\"foo:2.1.0\"]`.",
"type": "object",
"additionalProperties": {
"$ref": "#/definitions/Profile"
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overrides"
}
}
},
"panic": {
"$ref": "#/definitions/Panic"
},
"rpath": {
"description": "The `rpath` setting controls the [`-C rpath` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#rpath) which controls\nwhether or not [`rpath`](https://en.wikipedia.org/wiki/Rpath) is enabled.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#rpath"
}
}
}
}
},
"Profiles": {
"title": "Profiles",
"description": "Profiles provide a way to alter the compiler settings, influencing things like optimizations and debugging symbols.\n\nCargo has 4 built-in profiles: dev, release, test, and bench. It automatically chooses the profile based on which command is being run, the package and target that is being built, and command-line flags like --release.",
"type": "object",
"properties": {
"bench": {
"$ref": "#/definitions/ProfileWithBuildOverride"
},
"dev": {
"$ref": "#/definitions/ProfileWithBuildOverride"
},
"release": {
"$ref": "#/definitions/ProfileWithBuildOverride"
},
"test": {
"$ref": "#/definitions/ProfileWithBuildOverride"
}
},
"additionalProperties": {
"$ref": "#/definitions/ProfileWithBuildOverride"
},
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/profiles.html"
}
}
},
"Publish": {
"title": "Publish",
"description": "The `publish` field can be used to prevent a package from being published to a package registry (like *crates.io*) by mistake, for instance to keep a package\nprivate in a company.\n\n```toml\n[package]\n# ...\npublish = false\n```\n\nThe value may also be an array of strings which are registry names that are\nallowed to be published to.\n\n```toml\n[package]\n# ...\npublish = [\"some-registry-name\"]\n```",
"anyOf": [
{
"description": "A boolean indicating whether the package can be published.",
"type": "boolean",
"enum": [true, false],
"default": true,
"x-taplo": {
"docs": {
"enumValues": [
"The package can be published.",
"The package cannot be published."
]
}
}
},
{
"type": "array",
"description": "An array of registry names.",
"items": {
"type": "string"
}
}
],
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field"
}
}
},
"Readme": {
"title": "Readme",
"description": "The `readme` field should be the path to a file in the package root (relative\nto this `Cargo.toml`) that contains general information about the package.\nThis file will be transferred to the registry when you publish. [crates.io](https://crates.io)\nwill interpret it as Markdown and render it on the crate's page.\n\n```toml\n[package]\n# ...\nreadme = \"README.md\"\n```\n\nIf no value is specified for this field, and a file named `README.md`,\n`README.txt` or `README` exists in the package root, then the name of that\nfile will be used. You can suppress this behavior by setting this field to\n`false`. If the field is set to `true`, a default value of `README.md` will\nbe assumed.\n",
"anyOf": [
{
"description": "The `readme` field should be the path to a file in the package root (relative\nto this `Cargo.toml`) that contains general information about the package.",
"type": "string"
},
{
"type": "boolean",
"enum": [true, false],
"x-taplo": {
"docs": {
"enumValues": [
"Use the `README.md` file.",
"Do not use the default `README.md` file"
]
}
}
}
],
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-readme-field"
}
}
},
"SemVer": {
"title": "Semantic Version",
"description": "Cargo bakes in the concept of [Semantic Versioning](https://semver.org/), so make sure you follow some basic rules:\n\n* Before you reach 1.0.0, anything goes, but if you make breaking changes,\n increment the minor version. In Rust, breaking changes include adding fields to\n structs or variants to enums.\n* After 1.0.0, only make breaking changes when you increment the major version.\n Don't break the build.\n* After 1.0.0, don't add any new public API (no new `pub` anything) in patch-level\n versions. Always increment the minor version if you add any new `pub` structs,\n traits, fields, types, functions, methods or anything else.\n* Use version numbers with three numeric parts such as 1.0.0 rather than 1.0.",
"default": "0.1.0",
"type": "string",
"format": "semver",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field"
}
}
},
"SemVerRequirement": {
"title": "Semantic Version Requirement",
"description": "The [version requirement](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) of the target dependency.",
"default": "*",
"type": "string",
"format": "semver-requirement",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"
},
"plugins": ["crates"],
"crates": {
"schemas": "version"
}
}
},
"Target": {
"title": "Target",
"type": "object",
"properties": {
"bench": {
"description": "The `bench` field indicates whether or not the target is benchmarked by\ndefault by [`cargo bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html). The default is `true` for lib, bins, and\nbenchmarks.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-bench-field"
}
}
},
"crate-type": {
"description": "The `crate-type` field defines the [crate types](https://doc.rust-lang.org/reference/linkage.html) that will be generated by the\ntarget. It is an array of strings, allowing you to specify multiple crate\ntypes for a single target. This can only be specified for libraries and\nexamples. Binaries, tests, and benchmarks are always the \"bin\" crate type.\n\nThe available options are `bin`, `lib`, `rlib`, `dylib`, `cdylib`,\n`staticlib`, and `proc-macro`. You can read more about the different crate\ntypes in the [Rust Reference Manual](https://doc.rust-lang.org/reference/linkage.html).",
"type": "array",
"items": {
"description": "The `crate-type` field defines the [crate types](https://doc.rust-lang.org/reference/linkage.html) that will be generated by the\ntarget. It is an array of strings, allowing you to specify multiple crate\ntypes for a single target. This can only be specified for libraries and\nexamples. Binaries, tests, and benchmarks are always the \"bin\" crate type.\n\nThe available options are `bin`, `lib`, `rlib`, `dylib`, `cdylib`,\n`staticlib`, and `proc-macro`. You can read more about the different crate\ntypes in the [Rust Reference Manual](https://doc.rust-lang.org/reference/linkage.html).",
"type": "string",
"x-taplo": {
"docs": {
"enumValues": [
"A runnable executable will be produced. This requires that there is a `main` function in the crate which\nwill be run when the program begins executing. This will link in all Rust and\nnative dependencies, producing a distributable binary.",
"A Rust library will be produced.\nThis is an ambiguous concept as to what exactly is produced because a library\ncan manifest itself in several forms. The purpose of this generic `lib` option\nis to generate the \"compiler recommended\" style of library. The output library\nwill always be usable by rustc, but the actual type of library may change from\ntime-to-time. The remaining output types are all different flavors of\nlibraries, and the `lib` type can be seen as an alias for one of them (but the\nactual one is compiler-defined).",
"A \"Rust library\" file will be produced. This is used as an intermediate artifact and can be thought of as a\n\"static Rust library\". These `rlib` files, unlike `staticlib` files, are\ninterpreted by the compiler in future linkage. This essentially means\nthat `rustc` will look for metadata in `rlib` files like it looks for metadata\nin dynamic libraries. This form of output is used to produce statically linked\nexecutables as well as `staticlib` outputs.",
"A dynamic Rust library will be produced. This is different from the `lib` output type in that this forces\ndynamic library generation. The resulting dynamic library can be used as a\ndependency for other libraries and/or executables. This output type will\ncreate `*.so` files on linux, `*.dylib` files on osx, and `*.dll` files on\nwindows.",
"A dynamic system library will be produced. This is used when compiling\na dynamic library to be loaded from another language. This output type will\ncreate `*.so` files on Linux, `*.dylib` files on macOS, and `*.dll` files on\nWindows.",
"A static system library will be produced. This is different from other library outputs in that\nthe compiler will never attempt to link to `staticlib` outputs. The\npurpose of this output type is to create a static library containing all of\nthe local crate's code along with all upstream dependencies. The static\nlibrary is actually a `*.a` archive on linux and osx and a `*.lib` file on\nwindows. This format is recommended for use in situations such as linking\nRust code into an existing non-Rust application because it will not have\ndynamic dependencies on other Rust code.",
"The output produced is not specified, but if a `-L` path is provided to it then the\ncompiler will recognize the output artifacts as a macro and it can be loaded\nfor a program. Crates compiled with this crate type must only export\n[procedural macros](https://doc.rust-lang.org/reference/procedural-macros.html). The compiler will automatically set the `proc_macro`\n[configuration option](https://doc.rust-lang.org/reference/conditional-compilation.html). The crates are always compiled with the same target\nthat the compiler itself was built with. For example, if you are executing\nthe compiler from Linux with an `x86_64` CPU, the target will be\n`x86_64-unknown-linux-gnu` even if the crate is a dependency of another crate\nbeing built for a different target."
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-crate-type-field"
}
}
},
"x-taplo": {
"docs": {
"enumValues": [
"A runnable executable will be produced. This requires that there is a `main` function in the crate which\nwill be run when the program begins executing. This will link in all Rust and\nnative dependencies, producing a distributable binary.",
"A Rust library will be produced.\nThis is an ambiguous concept as to what exactly is produced because a library\ncan manifest itself in several forms. The purpose of this generic `lib` option\nis to generate the \"compiler recommended\" style of library. The output library\nwill always be usable by rustc, but the actual type of library may change from\ntime-to-time. The remaining output types are all different flavors of\nlibraries, and the `lib` type can be seen as an alias for one of them (but the\nactual one is compiler-defined).",
"A \"Rust library\" file will be produced. This is used as an intermediate artifact and can be thought of as a\n\"static Rust library\". These `rlib` files, unlike `staticlib` files, are\ninterpreted by the compiler in future linkage. This essentially means\nthat `rustc` will look for metadata in `rlib` files like it looks for metadata\nin dynamic libraries. This form of output is used to produce statically linked\nexecutables as well as `staticlib` outputs.",
"A dynamic Rust library will be produced. This is different from the `lib` output type in that this forces\ndynamic library generation. The resulting dynamic library can be used as a\ndependency for other libraries and/or executables. This output type will\ncreate `*.so` files on linux, `*.dylib` files on osx, and `*.dll` files on\nwindows.",
"A dynamic system library will be produced. This is used when compiling\na dynamic library to be loaded from another language. This output type will\ncreate `*.so` files on Linux, `*.dylib` files on macOS, and `*.dll` files on\nWindows.",
"A static system library will be produced. This is different from other library outputs in that\nthe compiler will never attempt to link to `staticlib` outputs. The\npurpose of this output type is to create a static library containing all of\nthe local crate's code along with all upstream dependencies. The static\nlibrary is actually a `*.a` archive on linux and osx and a `*.lib` file on\nwindows. This format is recommended for use in situations such as linking\nRust code into an existing non-Rust application because it will not have\ndynamic dependencies on other Rust code.",
"The output produced is not specified, but if a `-L` path is provided to it then the\ncompiler will recognize the output artifacts as a macro and it can be loaded\nfor a program. Crates compiled with this crate type must only export\n[procedural macros](https://doc.rust-lang.org/reference/procedural-macros.html). The compiler will automatically set the `proc_macro`\n[configuration option](https://doc.rust-lang.org/reference/conditional-compilation.html). The crates are always compiled with the same target\nthat the compiler itself was built with. For example, if you are executing\nthe compiler from Linux with an `x86_64` CPU, the target will be\n`x86_64-unknown-linux-gnu` even if the crate is a dependency of another crate\nbeing built for a different target."
]
},
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-crate-type-field"
}
}
},
"crate_type": {
"type": "array",
"items": {
"type": "string",
"x-taplo": {
"hidden": true
}
},
"x-taplo": {
"hidden": true
}
},
"doc": {
"description": "The `doc` field indicates whether or not the target is included in the\ndocumentation generated by [`cargo doc`](https://doc.rust-lang.org/cargo/commands/cargo-doc.html) by default. The default is `true` for\nlibraries and binaries.\n\n> **Note**: The binary will be skipped if its name is the same as the lib\n> target.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doc-field"
}
}
},
"doctest": {
"description": "The `doctest` field indicates whether or not [documentation examples](https://doc.rust-lang.org/rustdoc/documentation-tests.html) are\ntested by default by [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html). This is only relevant for libraries, it\nhas no effect on other sections. The default is `true` for the library.\n",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doctest-field"
}
}
},
"edition": {
"$ref": "#/definitions/Edition"
},
"harness": {
"description": "The `harness` field indicates that the [`--test` flag](https://doc.rust-lang.org/rustc/command-line-arguments.html#option-test) will be passed to\n`rustc` which will automatically include the libtest library which is the\ndriver for collecting and running tests marked with the [`#[test]` attribute](https://doc.rust-lang.org/reference/attributes/testing.html#the-test-attribute) or benchmarks with the `#[bench]` attribute. The\ndefault is `true` for all targets.\n\nIf set to `false`, then you are responsible for defining a `main()` function\nto run tests and benchmarks.\n\nTests have the [`cfg(test)` conditional expression](https://doc.rust-lang.org/reference/conditional-compilation.html#test) enabled whether\nor not the harness is enabled.",
"type": "boolean",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field"
}
}
},
"name": {
"description": "The `name` field specifies the name of the target, which corresponds to the\nfilename of the artifact that will be generated. For a library, this is the\ncrate name that dependencies will use to reference it.\n\nFor the `[lib]` and the default binary (`src/main.rs`), this defaults to the\nname of the package, with any dashes replaced with underscores. For other\n[auto discovered](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery) targets, it defaults to the\ndirectory or file name.\n\nThis is required for all targets except `[lib]`.",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-name-field"
}
}
},
"path": {
"description": "The `path` field specifies where the source for the crate is located, relative\nto the `Cargo.toml` file.\n\nIf not specified, the [inferred path](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery) is used based on\nthe target name.",
"type": "string",
"x-taplo": {
"links": {
"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-path-field"