schema stringclasses 471
values | key stringlengths 0 203 | description stringlengths 0 4.37k | object stringlengths 2 322k |
|---|---|---|---|
foxx-manifest.json | name | The name of the Foxx service. This will be shown in the web interface. | {"type": "string"} |
foxx-manifest.json | thumbnail | The filename of a thumbnail that will be used alongside the service in the web interface. This should be a JPEG or PNG image that looks good at sizes 50x50 and 160x160. | {"type": "string"} |
foxx-manifest.json | version | The version number of the Foxx service. The version number must follow the semantic versioning format. This will be shown in the web interface. | {"type": "string"} |
cargo.json | A schema for Cargo.toml. | {"$schema": "http://json-schema.org/draft-07/schema#", "definitions": {"Build": {"anyOf": [{"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": {"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": {"anyOf": [{}, {}]}, "DetailedDependency": {"type": "object", "properties": {"branch": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"}}}, "default-features": {"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": {"type": "array", "items": {"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": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"}}}, "optional": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"}}}, "package": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml"}}}, "path": {"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": {"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": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"}}}, "tag": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"}}}, "version": {}}, "x-taplo": {"initFields": ["version"]}}, "Edition": {"type": "string", "enum": ["2015", "2018", "2021"], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/stable/edition-guide/introduction.html"}}}, "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": {"type": "array", "items": {"type": "string"}}, "Resolver": {"type": "string", "enum": ["1", "2"], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions"}}}, "OptLevel": {"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": {"type": "object", "required": ["name", "version"], "properties": {"authors": {"anyOf": [{}, {}]}, "autobenches": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autobins": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autoexamples": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autotests": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "build": {}, "categories": {"anyOf": [{}, {}]}, "default-run": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-default-run-field"}}}, "documentation": {"anyOf": [{}, {}]}, "edition": {"anyOf": [{}, {}]}, "exclude": {"anyOf": [{}, {}]}, "homepage": {"anyOf": [{}, {}]}, "im-a-teapot": {"type": "boolean", "x-taplo": {"hidden": true}}, "include": {"anyOf": [{}, {}]}, "keywords": {"anyOf": [{}, {}]}, "license": {"anyOf": [{}, {}]}, "license-file": {"anyOf": [{}, {}]}, "links": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-links-field"}}}, "metabuild": {"x-taplo": {"hidden": true}}, "metadata": {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-metadata-table"}}}, "name": {"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": [{}, {}]}, "publish-lockfile": {"type": "boolean", "x-taplo": {"hidden": true}}, "readme": {"anyOf": [{}, {}]}, "repository": {"anyOf": [{}, {}]}, "resolver": {}, "rust-version": {"anyOf": [{}, {}]}, "version": {"anyOf": [{}, {}]}, "workspace": {"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": {"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": {"type": "object", "properties": {"build-dependencies": {"type": "object", "additionalProperties": {}, "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": {}, "x-taplo": {"hidden": true}}, "dependencies": {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"}}}, "dev-dependencies": {"type": "object", "additionalProperties": {}, "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": {}, "x-taplo": {"hidden": true}}}}, "BuildOverride": {"type": "object", "allOf": [{}], "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": [{}, {"type": "object", "properties": {"build-override": {}}}]}, "Profile": {"type": "object", "properties": {"codegen-units": {"type": "integer", "format": "uint32", "minimum": 0, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units"}}}, "debug": {}, "debug-assertions": {"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": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#incremental"}}}, "inherits": {"type": "string", "x-taplo": {"hidden": true}}, "lto": {}, "opt-level": {}, "overflow-checks": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overflow-checks"}}}, "package": {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overrides"}}}, "panic": {}, "rpath": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#rpath"}}}}}, "Profiles": {"type": "object", "properties": {"bench": {}, "dev": {}, "release": {}, "test": {}}, "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html"}}}, "Publish": {"anyOf": [{"type": "boolean", "enum": [true, false], "default": true, "x-taplo": {"docs": {"enumValues": ["The package can be published.", "The package cannot be published."]}}}, {"type": "array", "items": {"type": "string"}}], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field"}}}, "Readme": {"anyOf": [{"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": {"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": {"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": {"type": "object", "properties": {"bench": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-bench-field"}}}, "crate-type": {"type": "array", "items": {"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": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doc-field"}}}, "doctest": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doctest-field"}}}, "edition": {}, "harness": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field"}}}, "name": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-name-field"}}}, "path": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-path-field"}}}, "plugin": {"type": "boolean", "x-taplo": {"hidden": true}}, "proc-macro": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-proc-macro-field"}}}, "proc_macro": {"type": "boolean", "x-taplo": {"hidden": true}}, "required-features": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-required-features-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-required-features-field"}}}, "test": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-test-field"}}}}}, "Workspace": {"type": "object", "properties": {"default-members": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "dependencies": {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "exclude": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "members": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "metadata": {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "resolver": {}, "package": {"type": "object", "properties": {"authors": {}, "categories": {}, "documentation": {}, "edition": {}, "exclude": {}, "homepage": {}, "include": {}, "keywords": {}, "license": {}, "license-file": {}, "publish": {}, "readme": {}, "repository": {}, "rust-version": {}, "version": {}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-package-table"}}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html"}}}, "Authors": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field"}}}, "Categories": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-categories-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-categories-field"}}}, "Documentation": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-documentation-field"}}}, "Exclude": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "Homepage": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-homepage-field"}}}, "Include": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "Keywords": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field"}}}, "License": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields"}}}, "LicenseFile": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields"}}}, "Repository": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-repository-field"}}}, "RustVersion": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field"}}}, "WorkspaceInheritance": {"type": "object", "properties": {"workspace": {"type": "boolean", "enum": [true]}}}}, "properties": {"badges": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section"}}}, "bench": {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#benchmarks"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#benchmarks"}}}, "bin": {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#binaries"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#binaries"}}}, "build-dependencies": {"type": "object", "additionalProperties": {}, "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": {}, "x-taplo": {"hidden": true}}, "cargo-features": {"type": "array", "items": {"type": "string"}}, "dependencies": {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"}}}, "dev-dependencies": {"type": "object", "additionalProperties": {}, "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": {}, "x-taplo": {"hidden": true}}, "example": {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#examples"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#examples"}}}, "features": {"type": "object", "additionalProperties": {"type": "array", "items": {"type": "string"}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/features.html"}}}, "lib": {"x-taplo": {"docs": {"main": "The library target defines a \"library\" that can be used and linked by other\nlibraries and executables. The filename defaults to `src/lib.rs`, and the name\nof the library defaults to the name of the package. A package can have only\none library. The settings for the library can be [customized](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#configuring-a-target) in the `[lib]`\ntable in `Cargo.toml`.\n\n```toml\n# Example of customizing the library in Cargo.toml.\n[lib]\ncrate-type = [\"cdylib\"]\nbench = false\n```\n"}, "links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#library"}}}, "package": {}, "patch": {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/overriding-dependencies.html#the-patch-section"}}}, "profile": {}, "project": {"x-taplo": {"hidden": true}}, "replace": {"type": "object", "additionalProperties": {}, "x-taplo": {"hidden": true}}, "target": {"type": "object", "additionalProperties": {}}, "test": {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#integration-tests"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#integration-tests"}}}, "workspace": {}}, "type": "object", "x-taplo-info": {"authors": ["tamasfe (https://github.com/tamasfe)"], "patterns": ["^(.*(/|\\\\)Cargo\\.toml|Cargo\\.toml)$"]}} | |
cargo.json | Build | 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).
```toml
[package]
# ...
build = "build.rs"
```
The default is `"build.rs"`, which loads the script from a file named
`build.rs` in the root of the package. Use `build = "custom_build_name.rs"` to
specify a path to a different file or `build = false` to disable automatic
detection of the build script.
| {"anyOf": [{"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"}}} |
cargo.json | Build | Path to the build file. | {"type": "string"} |
cargo.json | DebugLevel | The `debug` setting controls the [`-C debuginfo` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#debuginfo) which controls the
amount 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"}}} |
cargo.json | branch | 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"}}} |
cargo.json | default-features | 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"}}} |
cargo.json | features | List of features to activate in the dependency. | {"type": "array", "items": {"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"}}} |
cargo.json | items | 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"}}} |
cargo.json | git | To depend on a library located in a `git` repository, the minimum information
you need to specify is the location of the repository with the `git` key:
```toml
[dependencies]
rand = { git = "https://github.com/rust-lang-nursery/rand" }
```
Cargo will fetch the `git` repository at this location then look for a
`Cargo.toml` for the requested crate anywhere inside the `git` repository
(not necessarily at the root - for example, specifying a member crate name
of a workspace and setting `git` to the repository containing the workspace).
Since we haven't specified any other information, Cargo assumes that
we intend to use the latest commit on the main branch to build our package.
You can combine the `git` key with the `rev`, `tag`, or `branch` keys to
specify something else. Here's an example of specifying that you want to use
the latest commit on a branch named `next`:
```toml
[dependencies]
rand = { git = "https://github.com/rust-lang-nursery/rand", branch = "next" }
```
See [Git Authentication](https://doc.rust-lang.org/cargo/appendix/git-authentication.html) for help with git authentication for private repos.
> **Note**: [crates.io](https://crates.io/) does not allow packages to be published with `git`
> dependencies (`git` [dev-dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies) are ignored). See the [Multiple
> locations](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#multiple-locations) section for a fallback alternative.
| {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories"}}} |
cargo.json | optional | Mark the dependency as optional.
Optional dependencies can be activated through features. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choosing-features"}}} |
cargo.json | package | Specify the name of the package.
When writing a `[dependencies]` section in `Cargo.toml` the key you write for a
dependency typically matches up to the name of the crate you import from in the
code. For some projects, though, you may wish to reference the crate with a
different name in the code regardless of how it's published on crates.io. For
example you may wish to:
* Avoid the need to `use foo as bar` in Rust source.
* Depend on multiple versions of a crate.
* Depend on crates with the same name from different registries.
To support this Cargo supports a `package` key in the `[dependencies]` section
of which package should be depended on:
```toml
[package]
name = "mypackage"
version = "0.0.1"
[dependencies]
foo = "0.1"
bar = { git = "https://github.com/example/project", package = "foo" }
baz = { version = "0.1", registry = "custom", package = "foo" }
```
In this example, three crates are now available in your Rust code:
```rust
extern crate foo; // crates.io
extern crate bar; // git repository
extern crate baz; // registry `custom`
```
All three of these crates have the package name of `foo` in their own
`Cargo.toml`, so we're explicitly using the `package` key to inform Cargo that
we want the `foo` package even though we're calling it something else locally.
The `package` key, if not specified, defaults to the name of the dependency
being requested.
| {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#renaming-dependencies-in-cargotoml"}}} |
cargo.json | path | Cargo supports **path dependencies** which are typically sub-crates that live within one repository.
Let's start off by making a new crate inside of our `hello_world` package:
```console
# inside of hello_world/
$ cargo new hello_utils
```
This will create a new folder `hello_utils` inside of which a `Cargo.toml` and
`src` folder are ready to be configured. In order to tell Cargo about this, open
up `hello_world/Cargo.toml` and add `hello_utils` to your dependencies:
```toml
[dependencies]
hello_utils = { path = "hello_utils" }
```
This tells Cargo that we depend on a crate called `hello_utils` which is found
in 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"}}} |
cargo.json | registry | To specify a dependency from a registry other than [crates.io](https://crates.io), first the
registry must be configured in a `.cargo/config.toml` file. See the [registries
documentation](https://doc.rust-lang.org/cargo/reference/registries.html) for more information. In the dependency, set the `registry` key
to the name of the registry to use.
```toml
[dependencies]
some-crate = { version = "1.0", registry = "my-registry" }
```
> **Note**: [crates.io](https://crates.io) does not allow packages to be published with
> dependencies on other registries.
| {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-other-registries"}}} |
cargo.json | rev | 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"}}} |
cargo.json | tag | 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"}}} |
cargo.json | Edition | The `edition` key affects which edition your package is compiled with. Cargo
will always generate packages via [`cargo new`](https://doc.rust-lang.org/cargo/commands/cargo-new.html) with the `edition` key set to the
latest edition. Setting the `edition` key in `[package]` will affect all
targets/crates in the package, including test suites, benchmarks, binaries,
examples, etc. | {"type": "string", "enum": ["2015", "2018", "2021"], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/stable/edition-guide/introduction.html"}}} |
cargo.json | Lto | 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
whole-program analysis, at the cost of longer linking time.
See 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"}}} |
cargo.json | Resolver | A different feature resolver algorithm can be used by specifying the resolver version in Cargo.toml like this:
[package]
name = "my-package"
version = "1.0.0"
resolver = "2"
The 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".
The version "2" resolver introduces changes in feature unification. See the features chapter for more details.
The 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:
[workspace]
members = ["member1", "member2"]
resolver = "2" | {"type": "string", "enum": ["1", "2"], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/resolver.html#resolver-versions"}}} |
cargo.json | OptLevel | 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
of optimization. Higher optimization levels may produce faster runtime code at
the expense of longer compiler times. Higher levels may also change and
rearrange the compiled code which may make it harder to use with a debugger.
It is recommended to experiment with different levels to find the right
balance for your project. There may be surprising results, such as level `3`
being slower than `2`, or the `"s"` and `"z"` levels not being necessarily
smaller. You may also want to reevaluate your settings over time as newer
versions of `rustc` changes optimization behavior.
See also [Profile Guided Optimization](https://doc.rust-lang.org/rustc/profile-guided-optimization.html) for more advanced optimization
techniques. | {"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"}}} |
cargo.json | Package | The only fields required by Cargo are [`name`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-name-field) and
[`version`](https://doc.rust-lang.org/cargo/reference/manifest.html#the-version-field). If publishing to a registry, the registry may
require 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", "version"], "properties": {"authors": {"anyOf": [{}, {}]}, "autobenches": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autobins": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autoexamples": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "autotests": {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}}, "build": {}, "categories": {"anyOf": [{}, {}]}, "default-run": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-default-run-field"}}}, "documentation": {"anyOf": [{}, {}]}, "edition": {"anyOf": [{}, {}]}, "exclude": {"anyOf": [{}, {}]}, "homepage": {"anyOf": [{}, {}]}, "im-a-teapot": {"type": "boolean", "x-taplo": {"hidden": true}}, "include": {"anyOf": [{}, {}]}, "keywords": {"anyOf": [{}, {}]}, "license": {"anyOf": [{}, {}]}, "license-file": {"anyOf": [{}, {}]}, "links": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-links-field"}}}, "metabuild": {"x-taplo": {"hidden": true}}, "metadata": {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-metadata-table"}}}, "name": {"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": [{}, {}]}, "publish-lockfile": {"type": "boolean", "x-taplo": {"hidden": true}}, "readme": {"anyOf": [{}, {}]}, "repository": {"anyOf": [{}, {}]}, "resolver": {}, "rust-version": {"anyOf": [{}, {}]}, "version": {"anyOf": [{}, {}]}, "workspace": {"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"}}} |
cargo.json | autobenches | Disable automatic discovery of `bench` targets.
Disabling automatic discovery should only be needed for specialized
situations. For example, if you have a library where you want a *module* named
`bin`, this would present a problem because Cargo would usually attempt to
compile anything in the `bin` directory as an executable. Here is a sample
layout of this scenario:
```
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs
```
| {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}} |
cargo.json | autobins | Disable automatic discovery of `bin` targets.
Disabling automatic discovery should only be needed for specialized
situations. For example, if you have a library where you want a *module* named
`bin`, this would present a problem because Cargo would usually attempt to
compile anything in the `bin` directory as an executable. Here is a sample
layout of this scenario:
```
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs
```
To prevent Cargo from inferring `src/bin/mod.rs` as an executable, set
this 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"}}} |
cargo.json | autoexamples | Disable automatic discovery of `example` targets.
Disabling automatic discovery should only be needed for specialized
situations. For example, if you have a library where you want a *module* named
`bin`, this would present a problem because Cargo would usually attempt to
compile anything in the `bin` directory as an executable. Here is a sample
layout of this scenario:
```
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs
```
| {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}} |
cargo.json | autotests | Disable automatic discovery of `test` targets.
Disabling automatic discovery should only be needed for specialized
situations. For example, if you have a library where you want a *module* named
`bin`, this would present a problem because Cargo would usually attempt to
compile anything in the `bin` directory as an executable. Here is a sample
layout of this scenario:
```
├── Cargo.toml
└── src
├── lib.rs
└── bin
└── mod.rs
```
| {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery"}}} |
cargo.json | default-run | The `default-run` field in the `[package]` section of the manifest can be used
to specify a default binary picked by [`cargo run`](https://doc.rust-lang.org/cargo/commands/cargo-run.html). For example, when there is
both `src/bin/a.rs` and `src/bin/b.rs`:
```toml
[package]
default-run = "a"
``` | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-default-run-field"}}} |
cargo.json | im-a-teapot | Sets whether the current package is a teapot or something else that is not capable of brewing tea. | {"type": "boolean", "x-taplo": {"hidden": true}} |
cargo.json | links | The `links` field specifies the name of a native library that is being linked
to. 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
script guide.
```toml
[package]
# ...
links = "foo"
``` | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-links-field"}}} |
cargo.json | metadata | Cargo by default will warn about unused keys in `Cargo.toml` to assist in
detecting typos and such. The `package.metadata` table, however, is completely
ignored by Cargo and will not be warned about. This section can be used for
tools which would like to store package configuration in `Cargo.toml`. For
example:
```toml
[package]
name = "..."
# ...
# Metadata used when generating an Android APK, for example.
[package.metadata.android]
package-name = "my-awesome-android-app"
assets = "path/to/static"
```
| {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-metadata-table"}}} |
cargo.json | name | The package name is an identifier used to refer to the package. It is used
when listed as a dependency in another package, and as the default name of
inferred lib and bin targets.
The name must use only [alphanumeric](https://doc.rust-lang.org/std/primitive.char.html#method.is_alphanumeric) characters or `-` or `_`, and cannot be empty.
Note 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
the package name, such as enforcing that it is a valid Rust identifier and not
a keyword. [crates.io](https://crates.io) imposes even more restrictions, such as
enforcing only ASCII characters, not a reserved name, not a special Windows
name 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"}}} |
cargo.json | workspace | The `workspace` field can be used to configure the workspace that this package
will be a member of. If not specified this will be inferred as the first
Cargo.toml with `[workspace]` upwards in the filesystem. Setting this is
useful if the member is not inside a subdirectory of the workspace root.
```toml
[package]
# ...
workspace = "path/to/workspace/root"
```
This field cannot be specified if the manifest already has a `[workspace]`
table defined. That is, a crate cannot both be a root crate in a workspace
(contain `[workspace]`) and also be a member crate of another workspace
(contain `package.workspace`).
For 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"}}} |
cargo.json | Panic | The `panic` setting controls the [`-C panic` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#panic) which controls which panic
strategy to use.
When set to `"unwind"`, the actual value depends on the default of the target
platform. For example, the NVPTX platform does not support unwinding, so it
always uses `"abort"`.
Tests, benchmarks, build scripts, and proc macros ignore the `panic` setting.
The `rustc` test harness currently requires `unwind` behavior. See the
[`panic-abort-tests`](https://doc.rust-lang.org/cargo/reference/unstable.html#panic-abort-tests) unstable flag which enables `abort` behavior.
Additionally, when using the `abort` strategy and building a test, all of the
dependencies 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"}}} |
cargo.json | build-dependencies | You can depend on other Cargo-based crates for use in your build scripts.
Dependencies are declared through the `build-dependencies` section of the
manifest:
```toml
[build-dependencies]
cc = "1.0.3"
```
The build script **does not** have access to the dependencies listed
in the `dependencies` or `dev-dependencies` section. Build
dependencies will likewise not be available to the package itself
unless listed under the `dependencies` section as well. A package
itself and its build script are built separately, so their
dependencies need not coincide. Cargo is kept simpler and cleaner by
using independent dependencies for independent purposes. | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#build-dependencies"}, "plugins": ["crates"], "crates": {"schemas": "dependencies"}}} |
cargo.json | dependencies | Cargo is configured to look for dependencies on [crates.io](https://crates.io) by default. Only
the name and a version string are required in this case. In [the cargo
guide](https://doc.rust-lang.org/cargo/guide/index.html), we specified a dependency on the `time` crate:
```toml
[dependencies]
time = "0.1.12"
```
The string `"0.1.12"` is a [semver](https://github.com/steveklabnik/semver#requirements) version requirement. Since this
string does not have any operators in it, it is interpreted the same way as
if we had specified `"^0.1.12"`, which is called a caret requirement.
A dependency can also be defined by a table with additional options:
```toml
[dependencies]
time = { path = "../time", version = "0.1.12" }
``` | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"}}} |
cargo.json | dev-dependencies | The format of `[dev-dependencies]` is equivalent to `[dependencies]`:
```toml
[dev-dependencies]
tempdir = "0.3"
```
Dev-dependencies are not used when compiling
a package for building, but are used for compiling tests, examples, and
benchmarks.
These dependencies are *not* propagated to other packages which depend on this
package.
You can also have target-specific development dependencies by using
`dev-dependencies` in the target section header instead of `dependencies`. For
example:
```toml
[target.'cfg(unix)'.dev-dependencies]
mio = "0.0.1"
```
> **Note**: When a package is published, only dev-dependencies that specify a
> `version` will be included in the published crate. For most use cases,
> dev-dependencies are not needed when published, though some users (like OS
> packagers) may want to run tests within a crate, so providing a `version` if
> possible can still be beneficial.
| {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies"}, "plugins": ["crates"], "crates": {"schemas": "dependencies"}}} |
cargo.json | BuildOverride | Profile settings can be overridden for specific packages and build-time
crates. To override the settings for a specific package, use the `package`
table to change the settings for the named package:
```toml
# The `foo` package will use the -Copt-level=3 flag.
[profile.dev.package.foo]
opt-level = 3
```
The package name is actually a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can
target individual versions of a package with syntax such as
`[profile.dev.package."foo:2.1.0"]`.
To override the settings for all dependencies (but not any workspace member),
use the `"*"` package name:
```toml
# Set the default for dependencies.
[profile.dev.package."*"]
opt-level = 2
```
To override the settings for build scripts, proc macros, and their
dependencies, use the `build-override` table:
```toml
# Set the settings for build scripts and proc-macros.
[profile.dev.build-override]
opt-level = 3
```
> Note: When a dependency is both a normal dependency and a build dependency,
> Cargo will try to only build it once when `--target` is not specified. When
> using `build-override`, the dependency may need to be built twice, once as a
> normal dependency and once with the overridden build settings. This may
> increase initial build times.
| {"type": "object", "allOf": [{}], "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"}}} |
cargo.json | codegen-units | The `codegen-units` setting controls the [`-C codegen-units` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#codegen-units) which
controls how many "code generation units" a crate will be split into. More
code generation units allows more of a crate to be processed in parallel
possibly reducing compile time, but may produce slower code.
This option takes an integer greater than 0.
The default is 256 for [incremental](https://doc.rust-lang.org/cargo/reference/profiles.html#incremental) builds, and 16 for
non-incremental builds. | {"type": "integer", "format": "uint32", "minimum": 0, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#codegen-units"}}} |
cargo.json | debug-assertions | The `debug-assertions` setting controls the [`-C debug-assertions` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#debug-assertions) which
turns `cfg(debug_assertions)` [conditional compilation](https://doc.rust-lang.org/reference/conditional-compilation.html#debug_assertions) on or off. Debug
assertions are intended to include runtime validation which is only available
in debug/development builds. These may be things that are too expensive or
otherwise undesirable in a release build. Debug assertions enables the
[`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"}}} |
cargo.json | incremental | The `incremental` setting controls the [`-C incremental` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#incremental) which controls
whether or not incremental compilation is enabled. Incremental compilation
causes `rustc` to to save additional information to disk which will be reused
when recompiling the crate, improving re-compile times. The additional
information is stored in the `target` directory.
The valid options are:
* `true`: enabled
* `false`: disabled
Incremental compilation is only used for workspace members and "path"
dependencies.
The incremental value can be overridden globally with the `CARGO_INCREMENTAL`
[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"}}} |
cargo.json | overflow-checks | The `overflow-checks` setting controls the [`-C overflow-checks` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#overflow-checks) which
controls the behavior of [runtime integer overflow](https://doc.rust-lang.org/reference/expressions/operator-expr.html#overflow). When overflow-checks are
enabled, a panic will occur on overflow. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overflow-checks"}}} |
cargo.json | package | Package-specific overrides.
The package name is a [Package ID Spec](https://doc.rust-lang.org/cargo/reference/pkgid-spec.html), so you can
target individual versions of a package with syntax such as `[profile.dev.package."foo:2.1.0"]`. | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html#overrides"}}} |
cargo.json | rpath | The `rpath` setting controls the [`-C rpath` flag](https://doc.rust-lang.org/rustc/codegen-options/index.html#rpath) which controls
whether 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"}}} |
cargo.json | Profiles | Profiles provide a way to alter the compiler settings, influencing things like optimizations and debugging symbols.
Cargo 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": {}, "dev": {}, "release": {}, "test": {}}, "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/profiles.html"}}} |
cargo.json | Publish | 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
private in a company.
```toml
[package]
# ...
publish = false
```
The value may also be an array of strings which are registry names that are
allowed to be published to.
```toml
[package]
# ...
publish = ["some-registry-name"]
``` | {"anyOf": [{"type": "boolean", "enum": [true, false], "default": true, "x-taplo": {"docs": {"enumValues": ["The package can be published.", "The package cannot be published."]}}}, {"type": "array", "items": {"type": "string"}}], "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-publish-field"}}} |
cargo.json | Publish | 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."]}}} |
cargo.json | Publish | An array of registry names. | {"type": "array", "items": {"type": "string"}} |
cargo.json | Readme | The `readme` field should be the path to a file in the package root (relative
to this `Cargo.toml`) that contains general information about the package.
This file will be transferred to the registry when you publish. [crates.io](https://crates.io)
will interpret it as Markdown and render it on the crate's page.
```toml
[package]
# ...
readme = "README.md"
```
If no value is specified for this field, and a file named `README.md`,
`README.txt` or `README` exists in the package root, then the name of that
file will be used. You can suppress this behavior by setting this field to
`false`. If the field is set to `true`, a default value of `README.md` will
be assumed.
| {"anyOf": [{"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"}}} |
cargo.json | Readme | The `readme` field should be the path to a file in the package root (relative
to this `Cargo.toml`) that contains general information about the package. | {"type": "string"} |
cargo.json | SemVer | Cargo bakes in the concept of [Semantic Versioning](https://semver.org/), so make sure you follow some basic rules:
* Before you reach 1.0.0, anything goes, but if you make breaking changes,
increment the minor version. In Rust, breaking changes include adding fields to
structs or variants to enums.
* After 1.0.0, only make breaking changes when you increment the major version.
Don't break the build.
* After 1.0.0, don't add any new public API (no new `pub` anything) in patch-level
versions. Always increment the minor version if you add any new `pub` structs,
traits, fields, types, functions, methods or anything else.
* 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"}}} |
cargo.json | SemVerRequirement | 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"}}} |
cargo.json | bench | The `bench` field indicates whether or not the target is benchmarked by
default by [`cargo bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html). The default is `true` for lib, bins, and
benchmarks. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-bench-field"}}} |
cargo.json | crate-type | The `crate-type` field defines the [crate types](https://doc.rust-lang.org/reference/linkage.html) that will be generated by the
target. It is an array of strings, allowing you to specify multiple crate
types for a single target. This can only be specified for libraries and
examples. Binaries, tests, and benchmarks are always the "bin" crate type.
The available options are `bin`, `lib`, `rlib`, `dylib`, `cdylib`,
`staticlib`, and `proc-macro`. You can read more about the different crate
types in the [Rust Reference Manual](https://doc.rust-lang.org/reference/linkage.html). | {"type": "array", "items": {"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"}}} |
cargo.json | items | The `crate-type` field defines the [crate types](https://doc.rust-lang.org/reference/linkage.html) that will be generated by the
target. It is an array of strings, allowing you to specify multiple crate
types for a single target. This can only be specified for libraries and
examples. Binaries, tests, and benchmarks are always the "bin" crate type.
The available options are `bin`, `lib`, `rlib`, `dylib`, `cdylib`,
`staticlib`, and `proc-macro`. You can read more about the different crate
types 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"}}} |
cargo.json | doc | The `doc` field indicates whether or not the target is included in the
documentation generated by [`cargo doc`](https://doc.rust-lang.org/cargo/commands/cargo-doc.html) by default. The default is `true` for
libraries and binaries.
> **Note**: The binary will be skipped if its name is the same as the lib
> target. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doc-field"}}} |
cargo.json | doctest | The `doctest` field indicates whether or not [documentation examples](https://doc.rust-lang.org/rustdoc/documentation-tests.html) are
tested by default by [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html). This is only relevant for libraries, it
has no effect on other sections. The default is `true` for the library.
| {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-doctest-field"}}} |
cargo.json | harness | The `harness` field indicates that the [`--test` flag](https://doc.rust-lang.org/rustc/command-line-arguments.html#option-test) will be passed to
`rustc` which will automatically include the libtest library which is the
driver 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
default is `true` for all targets.
If set to `false`, then you are responsible for defining a `main()` function
to run tests and benchmarks.
Tests have the [`cfg(test)` conditional expression](https://doc.rust-lang.org/reference/conditional-compilation.html#test) enabled whether
or not the harness is enabled. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field"}}} |
cargo.json | name | The `name` field specifies the name of the target, which corresponds to the
filename of the artifact that will be generated. For a library, this is the
crate name that dependencies will use to reference it.
For the `[lib]` and the default binary (`src/main.rs`), this defaults to the
name of the package, with any dashes replaced with underscores. For other
[auto discovered](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery) targets, it defaults to the
directory or file name.
This 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"}}} |
cargo.json | path | The `path` field specifies where the source for the crate is located, relative
to the `Cargo.toml` file.
If not specified, the [inferred path](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#target-auto-discovery) is used based on
the target name. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-path-field"}}} |
cargo.json | proc-macro | The `proc-macro` field indicates that the library is a [procedural macro](https://doc.rust-lang.org/book/ch19-06-macros.html)
([reference](https://doc.rust-lang.org/reference/procedural-macros.html)). This is only valid for the `[lib]`
target. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-proc-macro-field"}}} |
cargo.json | required-features | The `required-features` field specifies which [features](https://doc.rust-lang.org/cargo/reference/features.html) the target needs in
order to be built. If any of the required features are not enabled, the
target will be skipped. This is only relevant for the `[[bin]]`, `[[bench]]`,
`[[test]]`, and `[[example]]` sections, it has no effect on `[lib]`.
```toml
[features]
# ...
postgres = []
sqlite = []
tools = []
[[bin]]
name = "my-pg-tool"
required-features = ["postgres", "tools"]
```
| {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-required-features-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-required-features-field"}}} |
cargo.json | items | The `required-features` field specifies which [features](https://doc.rust-lang.org/cargo/reference/features.html) the target needs in
order to be built. If any of the required features are not enabled, the
target will be skipped. This is only relevant for the `[[bin]]`, `[[bench]]`,
`[[test]]`, and `[[example]]` sections, it has no effect on `[lib]`.
```toml
[features]
# ...
postgres = []
sqlite = []
tools = []
[[bin]]
name = "my-pg-tool"
required-features = ["postgres", "tools"]
```
| {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-required-features-field"}}} |
cargo.json | test | The `test` field indicates whether or not the target is tested by default by
[`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html). The default is `true` for lib, bins, and tests.
> **Note**: Examples are built by [`cargo test`](https://doc.rust-lang.org/cargo/commands/cargo-test.html) by default to ensure they
> continue to compile, but they are not *tested* by default. Setting `test =
> true` for an example will also build it as a test and run any
> [`#[test]`](https://doc.rust-lang.org/reference/attributes/testing.html#the-test-attribute) functions defined in the example. | {"type": "boolean", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-test-field"}}} |
cargo.json | Workspace | The `[workspace]` table in `Cargo.toml` defines which packages are members of
the workspace:
```toml
[workspace]
members = ["member1", "path/to/member2", "crates/*"]
exclude = ["crates/foo", "path/to/other"]
```
An empty `[workspace]` table can be used with a `[package]` to conveniently
create a workspace with the package and all of its path dependencies.
All [`path` dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-path-dependencies) residing in the workspace directory automatically
become members. Additional members can be listed with the `members` key, which
should be an array of strings containing directories with `Cargo.toml` files.
The `members` list also supports [globs](https://docs.rs/glob/0.3.0/glob/struct.Pattern.html) to match multiple paths, using
typical filename glob patterns like `*` and `?`.
The `exclude` key can be used to prevent paths from being included in a
workspace. This can be useful if some path dependencies aren't desired to be
in the workspace at all, or using a glob pattern and you want to remove a
directory.
An empty `[workspace]` table can be used with a `[package]` to conveniently
create a workspace with the package and all of its path dependencies. | {"type": "object", "properties": {"default-members": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "dependencies": {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "exclude": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "members": {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "metadata": {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "resolver": {}, "package": {"type": "object", "properties": {"authors": {}, "categories": {}, "documentation": {}, "edition": {}, "exclude": {}, "homepage": {}, "include": {}, "keywords": {}, "license": {}, "license-file": {}, "publish": {}, "readme": {}, "repository": {}, "rust-version": {}, "version": {}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-package-table"}}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html"}}} |
cargo.json | default-members | The optional `default-members` key can be specified to set the members to
operate on when in the workspace root and the package selection flags are not
used:
```toml
[workspace]
members = ["path/to/member1", "path/to/member2", "path/to/member3/*"]
default-members = ["path/to/member2", "path/to/member3/foo"]
```
When specified, `default-members` must expand to a subset of `members`. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | items | The optional `default-members` key can be specified to set the members to
operate on when in the workspace root and the package selection flags are not
used:
```toml
[workspace]
members = ["path/to/member1", "path/to/member2", "path/to/member3/*"]
default-members = ["path/to/member2", "path/to/member3/foo"]
```
When specified, `default-members` must expand to a subset of `members`. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | dependencies | The `workspace.dependencies` table is where you define dependencies to be
inherited by members of a workspace.
Specifying a workspace dependency is similar to [package dependencies](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) except:
- Dependencies from this table cannot be declared as `optional`
- [`features`][features] declared in this table are additive with the `features` from `[dependencies]`
You can then [inherit the workspace dependency as a package dependency](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#inheriting-a-dependency-from-a-workspace)
Example:
```toml
# [PROJECT_DIR]/Cargo.toml
[workspace]
members = ["bar"]
[workspace.dependencies]
cc = "1.0.73"
rand = "0.8.5"
regex = { version = "1.6.0", default-features = false, features = ["std"] }
```
```toml
# [PROJECT_DIR]/bar/Cargo.toml
[package]
name = "bar"
version = "0.2.0"
[dependencies]
regex = { workspace = true, features = ["unicode"] }
[build-dependencies]
cc.workspace = true
[dev-dependencies]
rand.workspace = true
``` | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | exclude | The `exclude` key can be used to prevent paths from being included in a
workspace. This can be useful if some path dependencies aren't desired to be
in the workspace at all, or using a glob pattern and you want to remove a
directory. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | items | The `exclude` key can be used to prevent paths from being included in a
workspace. This can be useful if some path dependencies aren't desired to be
in the workspace at all, or using a glob pattern and you want to remove a
directory. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | members | All [`path` dependencies] residing in the workspace directory automatically
become members. Additional members can be listed with the `members` key, which
should be an array of strings containing directories with `Cargo.toml` files.
The `members` list also supports [globs] to match multiple paths, using
typical filename glob patterns like `*` and `?`. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | items | All [`path` dependencies] residing in the workspace directory automatically
become members. Additional members can be listed with the `members` key, which
should be an array of strings containing directories with `Cargo.toml` files.
The `members` list also supports [globs] to match multiple paths, using
typical filename glob patterns like `*` and `?`. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | metadata | The `workspace.metadata` table is ignored by Cargo and will not be warned
about. This section can be used for tools that would like to store workspace
configuration in `Cargo.toml`. For example:
```toml
[workspace]
members = ["member1", "member2"]
[workspace.metadata.webcontents]
root = "path/to/webproject"
tool = ["npm", "run", "build"]
# ...
```
There is a similar set of tables at the package level at
`package.metadata`. While cargo does not specify a
format for the content of either of these tables, it is suggested that
external tools may wish to use them in a consistent fashion, such as referring
to the data in `workspace.metadata` if data is missing from `package.metadata`,
if that makes sense for the tool in question.
| {"type": "object", "additionalProperties": true, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-workspace-section"}}} |
cargo.json | package | The `workspace.package` table is where you define keys that can be
inherited by members of a workspace. These keys can be inherited by
defining them in the member package with `{key}.workspace = true`.
Keys that are supported:
| | |
|----------------|-----------------|
| `authors` | `categories` |
| `description` | `documentation` |
| `edition` | `exclude` |
| `homepage` | `include` |
| `keywords` | `license` |
| `license-file` | `publish` |
| `readme` | `repository` |
| `rust-version` | `version` |
- `license-file` and `readme` are relative to the workspace root
- `include` and `exclude` are relative to your package root
Example:
```toml
# [PROJECT_DIR]/Cargo.toml
[workspace]
members = ["bar"]
[workspace.package]
version = "1.2.3"
authors = ["Nice Folks"]
description = "A short description of my package"
documentation = "https://example.com/bar"
```
```toml
# [PROJECT_DIR]/bar/Cargo.toml
[package]
name = "bar"
version.workspace = true
authors.workspace = true
description.workspace = true
documentation.workspace = true
``` | {"type": "object", "properties": {"authors": {}, "categories": {}, "documentation": {}, "edition": {}, "exclude": {}, "homepage": {}, "include": {}, "keywords": {}, "license": {}, "license-file": {}, "publish": {}, "readme": {}, "repository": {}, "rust-version": {}, "version": {}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/workspaces.html#the-package-table"}}} |
cargo.json | Authors | The `authors` field lists people or organizations that are considered the
"authors" of the package. The exact meaning is open to interpretation — it may
list the original or primary authors, current maintainers, or owners of the
package. These names will be listed on the crate's page on
[crates.io](https://crates.io). An optional email address may be included within angled
brackets at the end of each author.
> **Note**: [crates.io](https://crates.io) requires at least one author to be listed. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field"}}} |
cargo.json | items | The `authors` field lists people or organizations that are considered the
"authors" of the package. The exact meaning is open to interpretation — it may
list the original or primary authors, current maintainers, or owners of the
package. These names will be listed on the crate's page on
[crates.io](https://crates.io). An optional email address may be included within angled
brackets at the end of each author.
> **Note**: [crates.io](https://crates.io) requires at least one author to be listed. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-authors-field"}}} |
cargo.json | Categories | The `categories` field is an array of strings of the categories this package
belongs to.
```toml
categories = ["command-line-utilities", "development-tools::cargo-plugins"]
```
> **Note**: [crates.io](https://crates.io) has a maximum of 5 categories. Each category should
> match one of the strings available at https://crates.io/category_slugs, and
> must match exactly. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-categories-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-categories-field"}}} |
cargo.json | items | The `categories` field is an array of strings of the categories this package
belongs to.
```toml
categories = ["command-line-utilities", "development-tools::cargo-plugins"]
```
> **Note**: [crates.io](https://crates.io) has a maximum of 5 categories. Each category should
> match one of the strings available at https://crates.io/category_slugs, and
> must match exactly. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-categories-field"}}} |
cargo.json | Description | The description is a short blurb about the package. [crates.io](https://crates.io) will display
this with your package. This should be plain text (not Markdown).
```toml
[package]
# ...
description = "A short description of my package"
```
> **Note**: [crates.io](https://crates.io) requires the `description` to be set. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-description-field"}}} |
cargo.json | Documentation |
The `documentation` field specifies a URL to a website hosting the crate's
documentation. If no URL is specified in the manifest file, [crates.io](https://crates.io) will
automatically link your crate to the corresponding [docs.rs](https://docs.rs) page.
```toml
[package]
# ...
documentation = "https://docs.rs/bitflags"
```
| {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-documentation-field"}}} |
cargo.json | Exclude | You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.
The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:
- `foo` matches any file or directory with the name `foo` anywhere in the
package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
- `*` matches zero or more characters except `/`. For example, `*.html`
matches any file or directory with the `.html` extension anywhere in the
package.
- `?` matches any character except `/`. For example, `foo?` matches `food`,
but not `foo`.
- `[]` allows for matching a range of characters. For example, `[ab]`
matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
files inside directory `foo`, including all files in subdirectories below
`foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
`a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
`!foo.rs` would match all files with the `.rs` extension inside the `src`
directory, except for any file named `foo.rs`.
If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.
```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```
```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```
The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.
The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}} |
cargo.json | items | You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.
The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:
- `foo` matches any file or directory with the name `foo` anywhere in the
package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
- `*` matches zero or more characters except `/`. For example, `*.html`
matches any file or directory with the `.html` extension anywhere in the
package.
- `?` matches any character except `/`. For example, `foo?` matches `food`,
but not `foo`.
- `[]` allows for matching a range of characters. For example, `[ab]`
matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
files inside directory `foo`, including all files in subdirectories below
`foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
`a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
`!foo.rs` would match all files with the `.rs` extension inside the `src`
directory, except for any file named `foo.rs`.
If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.
```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```
```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```
The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.
The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}} |
cargo.json | Homepage | The `homepage` field should be a URL to a site that is the home page for your
package.
```toml
[package]
# ...
homepage = "https://serde.rs/"
``` | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-homepage-field"}}} |
cargo.json | Include | You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.
The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:
- `foo` matches any file or directory with the name `foo` anywhere in the
package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
- `*` matches zero or more characters except `/`. For example, `*.html`
matches any file or directory with the `.html` extension anywhere in the
package.
- `?` matches any character except `/`. For example, `foo?` matches `food`,
but not `foo`.
- `[]` allows for matching a range of characters. For example, `[ab]`
matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
files inside directory `foo`, including all files in subdirectories below
`foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
`a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
`!foo.rs` would match all files with the `.rs` extension inside the `src`
directory, except for any file named `foo.rs`.
If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.
```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```
```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```
The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.
The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}} |
cargo.json | items | You can explicitly specify that a set of file patterns should be ignored or
included for the purposes of packaging. The patterns specified in the
`exclude` field identify a set of files that are not included, and the
patterns in `include` specify files that are explicitly included.
The patterns should be [gitignore](https://git-scm.com/docs/gitignore)-style patterns. Briefly:
- `foo` matches any file or directory with the name `foo` anywhere in the
package. This is equivalent to the pattern `**/foo`.
- `/foo` matches any file or directory with the name `foo` only in the root of
the package.
- `foo/` matches any *directory* with the name `foo` anywhere in the package.
- Common glob patterns like `*`, `?`, and `[]` are supported:
- `*` matches zero or more characters except `/`. For example, `*.html`
matches any file or directory with the `.html` extension anywhere in the
package.
- `?` matches any character except `/`. For example, `foo?` matches `food`,
but not `foo`.
- `[]` allows for matching a range of characters. For example, `[ab]`
matches either `a` or `b`. `[a-z]` matches letters a through z.
- `**/` prefix matches in any directory. For example, `**/foo/bar` matches the
file or directory `bar` anywhere that is directly under directory `foo`.
- `/**` suffix matches everything inside. For example, `foo/**` matches all
files inside directory `foo`, including all files in subdirectories below
`foo`.
- `/**/` matches zero or more directories. For example, `a/**/b` matches
`a/b`, `a/x/b`, `a/x/y/b`, and so on.
- `!` prefix negates a pattern. For example, a pattern of `src/**.rs` and
`!foo.rs` would match all files with the `.rs` extension inside the `src`
directory, except for any file named `foo.rs`.
If git is being used for a package, the `exclude` field will be seeded with
the `gitignore` settings from the repository.
```toml
[package]
# ...
exclude = ["build/**/*.o", "doc/**/*.html"]
```
```toml
[package]
# ...
include = ["src/**/*", "Cargo.toml"]
```
The options are mutually exclusive: setting `include` will override an
`exclude`. Note that `include` must be an exhaustive list of files as otherwise
necessary source files may not be included. The package's `Cargo.toml` is
automatically included.
The include/exclude list is also used for change tracking in some situations.
For targets built with `rustdoc`, it is used to determine the list of files to
track to determine if the target should be rebuilt. If the package has a
[build script](https://doc.rust-lang.org/cargo/reference/build-scripts.html) that does not emit any `rerun-if-*` directives, then the
include/exclude list is used for tracking if the build script should be re-run
if any of those files change. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-exclude-and-include-fields"}}} |
cargo.json | Keywords | The `keywords` field is an array of strings that describe this package. This
can help when searching for the package on a registry, and you may choose any
words that would help someone find this crate.
```toml
[package]
# ...
keywords = ["gamedev", "graphics"]
```
> **Note**: [crates.io](https://crates.io) has a maximum of 5 keywords. Each keyword must be
> ASCII text, start with a letter, and only contain letters, numbers, `_` or
> `-`, and have at most 20 characters. | {"type": "array", "items": {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field"}}} |
cargo.json | items | The `keywords` field is an array of strings that describe this package. This
can help when searching for the package on a registry, and you may choose any
words that would help someone find this crate.
```toml
[package]
# ...
keywords = ["gamedev", "graphics"]
```
> **Note**: [crates.io](https://crates.io) has a maximum of 5 keywords. Each keyword must be
> ASCII text, start with a letter, and only contain letters, numbers, `_` or
> `-`, and have at most 20 characters. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-keywords-field"}}} |
cargo.json | License | The `license` field contains the name of the software license that the package
is released under.
[crates.io](https://crates.io/) interprets the `license` field as an [SPDX 2.1 license
expression](https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60). The name must be a known license
from the [SPDX license list 3.6](https://github.com/spdx/license-list-data/tree/v3.6). Parentheses are not
currently supported. See the [SPDX site](https://spdx.org/license-list) for more information.
SPDX license expressions support AND and OR operators to combine multiple
licenses.
```toml
[package]
# ...
license = "MIT OR Apache-2.0"
```
Using `OR` indicates the user may choose either license. Using `AND` indicates
the user must comply with both licenses simultaneously. The `WITH` operator
indicates a license with a special exception. Some examples:
* `MIT OR Apache-2.0`
* `LGPL-2.1 AND MIT AND BSD-2-Clause`
* `GPL-2.0+ WITH Bison-exception-2.2`
If a package is using a nonstandard license, then the `license-file` field may
be specified in lieu of the `license` field. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields"}}} |
cargo.json | LicenseFile | The `license-file` field contains the path to a file
containing the text of the license (relative to this `Cargo.toml`).
```toml
[package]
# ...
license-file = "LICENSE.txt"
```
> **Note**: [crates.io](https://crates.io) requires either `license` or `license-file` to be set. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-license-and-license-file-fields"}}} |
cargo.json | Repository | The `repository` field should be a URL to the source repository for your
package.
```toml
[package]
# ...
repository = "https://github.com/rust-lang/cargo/"
``` | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-repository-field"}}} |
cargo.json | RustVersion | The `rust-version` field is an optional key that tells cargo what version of the
Rust language and compiler your package can be compiled with. If the currently
selected version of the Rust compiler is older than the stated version, cargo
will exit with an error, telling the user what version is required.
The first version of Cargo that supports this field was released with Rust 1.56.0.
In older releases, the field will be ignored, and Cargo will display a warning.
```toml
[package]
# ...
rust-version = "1.56"
```
The Rust version must be a bare version number with two or three components; it
cannot include semver operators or pre-release identifiers. Compiler pre-release
identifiers such as -nightly will be ignored while checking the Rust version.
The `rust-version` must be equal to or newer than the version that first
introduced the configured `edition`.
The `rust-version` may be ignored using the `--ignore-rust-version` option.
Setting the `rust-version` key in `[package]` will affect all targets/crates in
the package, including test suites, benchmarks, binaries, examples, etc. | {"type": "string", "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-rust-version-field"}}} |
cargo.json | WorkspaceInheritance | The `workspace` field allow keys to be inherited by defining them in the member package with `{key}.workspace = true` | {"type": "object", "properties": {"workspace": {"type": "boolean", "enum": [true]}}} |
cargo.json | badges | [crates.io](https://crates.io) can display various badges for build status, test coverage, etc. for
each crate. All badges are optional.
- The badges pertaining to build status that are currently available are
Appveyor, CircleCI, Cirrus CI, GitLab, Azure DevOps, Travis CI and Bitbucket
Pipelines.
- Available badges pertaining to code test coverage are Codecov and Coveralls.
- There are also maintenance-related badges based on isitmaintained.com
which state the issue resolution time, percent of open issues, and future
maintenance intentions.
Most badge specifications require a `repository` key. It is expected to be in
`user/repo` format.
```toml
[badges]
# Appveyor: `repository` is required. `branch` is optional; default is `master`
# `service` is optional; valid values are `github` (default), `bitbucket`, and
# `gitlab`; `id` is optional; you can specify the appveyor project id if you
# want to use that instead. `project_name` is optional; use when the repository
# name differs from the appveyor project name.
appveyor = { repository = "...", branch = "master", service = "github" }
# Circle CI: `repository` is required. `branch` is optional; default is `master`
circle-ci = { repository = "...", branch = "master" }
# Cirrus CI: `repository` is required. `branch` is optional; default is `master`
cirrus-ci = { repository = "...", branch = "master" }
# GitLab: `repository` is required. `branch` is optional; default is `master`
gitlab = { repository = "...", branch = "master" }
# Azure DevOps: `project` is required. `pipeline` is required. `build` is optional; default is `1`
# Note: project = `organization/project`, pipeline = `name_of_pipeline`, build = `definitionId`
azure-devops = { project = "...", pipeline = "...", build="2" }
# Travis CI: `repository` in format "<user>/<project>" is required.
# `branch` is optional; default is `master`
travis-ci = { repository = "...", branch = "master" }
# Bitbucket Pipelines: `repository` is required. `branch` is required
bitbucket-pipelines = { repository = "...", branch = "master" }
# Codecov: `repository` is required. `branch` is optional; default is `master`
# `service` is optional; valid values are `github` (default), `bitbucket`, and
# `gitlab`.
codecov = { repository = "...", branch = "master", service = "github" }
# Coveralls: `repository` is required. `branch` is optional; default is `master`
# `service` is optional; valid values are `github` (default) and `bitbucket`.
coveralls = { repository = "...", branch = "master", service = "github" }
# Is it maintained resolution time: `repository` is required.
is-it-maintained-issue-resolution = { repository = "..." }
# Is it maintained percentage of open issues: `repository` is required.
is-it-maintained-open-issues = { repository = "..." }
# Maintenance: `status` is required. Available options are:
# - `actively-developed`: New features are being added and bugs are being fixed.
# - `passively-maintained`: There are no plans for new features, but the maintainer intends to
# respond to issues that get filed.
# - `as-is`: The crate is feature complete, the maintainer does not intend to continue working on
# it or providing support, but it works for the purposes it was designed for.
# - `experimental`: The author wants to share it with the community but is not intending to meet
# anyone's particular use case.
# - `looking-for-maintainer`: The current maintainer would like to transfer the crate to someone
# else.
# - `deprecated`: The maintainer does not recommend using this crate (the description of the crate
# can describe why, there could be a better solution available or there could be problems with
# the crate that the author does not want to fix).
# - `none`: Displays no badge on crates.io, since the maintainer has not chosen to specify
# their intentions, potential crate users will need to investigate on their own.
maintenance = { status = "..." }
``` | {"type": "object", "additionalProperties": {"type": "object", "additionalProperties": {"type": "string"}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/manifest.html#the-badges-section"}}} |
cargo.json | bench | Benchmarks provide a way to test the performance of your code using the
[`cargo bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html) command. They follow the same structure as [tests](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#tests),
with each benchmark function annotated with the `#[bench]` attribute.
Similarly to tests:
* Benchmarks are placed in the [`benches` directory](https://doc.rust-lang.org/cargo/guide/project-layout.html).
* Benchmark functions defined in libraries and binaries have access to the
*private* API within the target they are defined in. Benchmarks in the
`benches` directory may use the *public* API.
* [The `bench` field](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-bench-field) can be used to define which targets
are benchmarked by default.
* [The `harness` field](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field) can be used to disable the
built-in harness.
> **Note**: The [`#[bench]`
> attribute](https://doc.rust-lang.org/unstable-book/library-features/test.html) is currently
> unstable and only available on the [nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html). There are some
> packages available on [crates.io](https://crates.io/keywords/benchmark) that
> may help with running benchmarks on the stable channel, such as
> [Criterion](https://crates.io/crates/criterion). | {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#benchmarks"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#benchmarks"}}} |
cargo.json | items | Benchmarks provide a way to test the performance of your code using the
[`cargo bench`](https://doc.rust-lang.org/cargo/commands/cargo-bench.html) command. They follow the same structure as [tests](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#tests),
with each benchmark function annotated with the `#[bench]` attribute.
Similarly to tests:
* Benchmarks are placed in the [`benches` directory](https://doc.rust-lang.org/cargo/guide/project-layout.html).
* Benchmark functions defined in libraries and binaries have access to the
*private* API within the target they are defined in. Benchmarks in the
`benches` directory may use the *public* API.
* [The `bench` field](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-bench-field) can be used to define which targets
are benchmarked by default.
* [The `harness` field](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#the-harness-field) can be used to disable the
built-in harness.
> **Note**: The [`#[bench]`
> attribute](https://doc.rust-lang.org/unstable-book/library-features/test.html) is currently
> unstable and only available on the [nightly channel](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html). There are some
> packages available on [crates.io](https://crates.io/keywords/benchmark) that
> may help with running benchmarks on the stable channel, such as
> [Criterion](https://crates.io/crates/criterion). | {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#benchmarks"}}} |
cargo.json | bin | Binary targets are executable programs that can be run after being compiled.
The default binary filename is `src/main.rs`, which defaults to the name of
the package. Additional binaries are stored in the [`src/bin/`
directory](https://doc.rust-lang.org/cargo/guide/project-layout.html). The settings for each binary can be [customized](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#configuring-a-target) in the `[[bin]]` tables in `Cargo.toml`.
Binaries can use the public API of the package's library. They are also linked
with the [`[dependencies]`](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) defined in `Cargo.toml`.
You can run individual binaries with the [`cargo run`](https://doc.rust-lang.org/cargo/commands/cargo-run.html) command with the `--bin
<bin-name>` option. [`cargo install`](https://doc.rust-lang.org/cargo/commands/cargo-install.html) can be used to copy the executable to a
common location.
```toml
# Example of customizing binaries in Cargo.toml.
[[bin]]
name = "cool-tool"
test = false
bench = false
[[bin]]
name = "frobnicator"
required-features = ["frobnicate"]
``` | {"type": "array", "items": {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#binaries"}}}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#binaries"}}} |
cargo.json | items | Binary targets are executable programs that can be run after being compiled.
The default binary filename is `src/main.rs`, which defaults to the name of
the package. Additional binaries are stored in the [`src/bin/`
directory](https://doc.rust-lang.org/cargo/guide/project-layout.html). The settings for each binary can be [customized](https://doc.rust-lang.org/cargo/reference/cargo-targets.html#configuring-a-target) in the `[[bin]]` tables in `Cargo.toml`.
Binaries can use the public API of the package's library. They are also linked
with the [`[dependencies]`](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html) defined in `Cargo.toml`.
You can run individual binaries with the [`cargo run`](https://doc.rust-lang.org/cargo/commands/cargo-run.html) command with the `--bin
<bin-name>` option. [`cargo install`](https://doc.rust-lang.org/cargo/commands/cargo-install.html) can be used to copy the executable to a
common location.
```toml
# Example of customizing binaries in Cargo.toml.
[[bin]]
name = "cool-tool"
test = false
bench = false
[[bin]]
name = "frobnicator"
required-features = ["frobnicate"]
``` | {"x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/cargo-targets.html#binaries"}}} |
cargo.json | build-dependencies | You can depend on other Cargo-based crates for use in your build scripts.
Dependencies are declared through the `build-dependencies` section of the
manifest:
```toml
[build-dependencies]
cc = "1.0.3"
```
The build script **does not** have access to the dependencies listed
in the `dependencies` or `dev-dependencies` section. Build
dependencies will likewise not be available to the package itself
unless listed under the `dependencies` section as well. A package
itself and its build script are built separately, so their
dependencies need not coincide. Cargo is kept simpler and cleaner by
using independent dependencies for independent purposes. | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#build-dependencies"}, "plugins": ["crates"], "crates": {"schemas": "dependencies"}}} |
cargo.json | dependencies | Cargo is configured to look for dependencies on [crates.io](https://crates.io) by default. Only
the name and a version string are required in this case. In [the cargo
guide](https://doc.rust-lang.org/cargo/guide/index.html), we specified a dependency on the `time` crate:
```toml
[dependencies]
time = "0.1.12"
```
The string `"0.1.12"` is a [semver](https://github.com/steveklabnik/semver#requirements) version requirement. Since this
string does not have any operators in it, it is interpreted the same way as
if we had specified `"^0.1.12"`, which is called a caret requirement.
A dependency can also be defined by a table with additional options:
```toml
[dependencies]
time = { path = "../time", version = "0.1.12" }
``` | {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html"}}} |
cargo.json | dev-dependencies | The format of `[dev-dependencies]` is equivalent to `[dependencies]`:
```toml
[dev-dependencies]
tempdir = "0.3"
```
Dev-dependencies are not used when compiling
a package for building, but are used for compiling tests, examples, and
benchmarks.
These dependencies are *not* propagated to other packages which depend on this
package.
You can also have target-specific development dependencies by using
`dev-dependencies` in the target section header instead of `dependencies`. For
example:
```toml
[target.'cfg(unix)'.dev-dependencies]
mio = "0.0.1"
```
> **Note**: When a package is published, only dev-dependencies that specify a
> `version` will be included in the published crate. For most use cases,
> dev-dependencies are not needed when published, though some users (like OS
> packagers) may want to run tests within a crate, so providing a `version` if
> possible can still be beneficial.
| {"type": "object", "additionalProperties": {}, "x-taplo": {"links": {"key": "https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#development-dependencies"}, "plugins": ["crates"], "crates": {"schemas": "dependencies"}}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.