cargo-rustc(1)

1CARGO-RUSTC(1)              General Commands Manual             CARGO-RUSTC(1)
2
3
4

NAME

6       cargo-rustc - Compile the current package, and pass extra options to
7       the compiler
8

SYNOPSIS

10       cargo rustc [options] [-- args]
11

DESCRIPTION

13       The specified target for the current package (or package specified by
14       -p if provided) will be compiled along with all of its dependencies.
15       The specified args will all be passed to the final compiler invocation,
16       not any of the dependencies. Note that the compiler will still
17       unconditionally receive arguments such as -L, --extern, and
18       --crate-type, and the specified args will simply be added to the
19       compiler invocation.
20
21       See <https://doc.rust-lang.org/rustc/index.html> for documentation on
22       rustc flags.
23
24       This command requires that only one target is being compiled when
25       additional arguments are provided. If more than one target is available
26       for the current package the filters of --lib, --bin, etc, must be used
27       to select which target is compiled.
28
29       To pass flags to all compiler processes spawned by Cargo, use the
30       RUSTFLAGS environment variable
31       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
32       or the build.rustflags config value
33       <https://doc.rust-lang.org/cargo/reference/config.html>.
34

OPTIONS

36   Package Selection
37       By default, the package in the current working directory is selected.
38       The -p flag can be used to choose a different package in a workspace.
39
40       -p spec, --package spec
41           The package to build. See cargo-pkgid(1) for the SPEC format.
42
43   Target Selection
44       When no target selection options are given, cargo rustc will build all
45       binary and library targets of the selected package.
46
47       Passing target selection flags will build only the specified targets.
48
49       Note that --bin, --example, --test and --bench flags also support
50       common Unix glob patterns like *, ? and []. However, to avoid your
51       shell accidentally expanding glob patterns before Cargo handles them,
52       you must use single quotes or double quotes around each glob pattern.
53
54       --lib
55           Build the package's library.
56
57       --bin name...
58           Build the specified binary. This flag may be specified multiple
59           times and supports common Unix glob patterns.
60
61       --bins
62           Build all binary targets.
63
64       --example name...
65           Build the specified example. This flag may be specified multiple
66           times and supports common Unix glob patterns.
67
68       --examples
69           Build all example targets.
70
71       --test name...
72           Build the specified integration test. This flag may be specified
73           multiple times and supports common Unix glob patterns.
74
75       --tests
76           Build all targets in test mode that have the test = true manifest
77           flag set. By default this includes the library and binaries built
78           as unittests, and integration tests. Be aware that this will also
79           build any required dependencies, so the lib target may be built
80           twice (once as a unittest, and once as a dependency for binaries,
81           integration tests, etc.). Targets may be enabled or disabled by
82           setting the test flag in the manifest settings for the target.
83
84       --bench name...
85           Build the specified benchmark. This flag may be specified multiple
86           times and supports common Unix glob patterns.
87
88       --benches
89           Build all targets in benchmark mode that have the bench = true
90           manifest flag set. By default this includes the library and
91           binaries built as benchmarks, and bench targets. Be aware that this
92           will also build any required dependencies, so the lib target may be
93           built twice (once as a benchmark, and once as a dependency for
94           binaries, benchmarks, etc.). Targets may be enabled or disabled by
95           setting the bench flag in the manifest settings for the target.
96
97       --all-targets
98           Build all targets. This is equivalent to specifying --lib --bins
99           --tests --benches --examples.
100
101   Feature Selection
102       The feature flags allow you to control which features are enabled. When
103       no feature options are given, the default feature is activated for
104       every selected package.
105
106       See the features documentation
107       <https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options>
108       for more details.
109
110       --features features
111           Space or comma separated list of features to activate. Features of
112           workspace members may be enabled with package-name/feature-name
113           syntax. This flag may be specified multiple times, which enables
114           all specified features.
115
116       --all-features
117           Activate all available features of all selected packages.
118
119       --no-default-features
120           Do not activate the default feature of the selected packages.
121
122   Compilation Options
123       --target triple
124           Build for the given architecture. The default is the host
125           architecture. The general format of the triple is
126           <arch><sub>-<vendor>-<sys>-<abi>. Run rustc --print target-list for
127           a list of supported targets.
128
129           This may also be specified with the build.target config value
130           <https://doc.rust-lang.org/cargo/reference/config.html>.
131
132           Note that specifying this flag makes Cargo run in a different mode
133           where the target artifacts are placed in a separate directory. See
134           the build cache
135           <https://doc.rust-lang.org/cargo/guide/build-cache.html>
136           documentation for more details.
137
138       --release
139           Build optimized artifacts with the release profile. See the
140           PROFILES section for details on how this affects profile selection.
141
142   Output Options
143       --target-dir directory
144           Directory for all generated artifacts and intermediate files. May
145           also be specified with the CARGO_TARGET_DIR environment variable,
146           or the build.target-dir config value
147           <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
148           to target in the root of the workspace.
149
150   Display Options
151       -v, --verbose
152           Use verbose output. May be specified twice for "very verbose"
153           output which includes extra output such as dependency warnings and
154           build script output. May also be specified with the term.verbose
155           config value
156           <https://doc.rust-lang.org/cargo/reference/config.html>.
157
158       -q, --quiet
159           No output printed to stdout.
160
161       --color when
162           Control when colored output is used. Valid values:
163
164           ·  auto (default): Automatically detect if color support is
165               available on the terminal.
166
167           ·  always: Always display colors.
168
169           ·  never: Never display colors.
170
171           May also be specified with the term.color config value
172           <https://doc.rust-lang.org/cargo/reference/config.html>.
173
174       --message-format fmt
175           The output format for diagnostic messages. Can be specified
176           multiple times and consists of comma-separated values. Valid
177           values:
178
179           ·  human (default): Display in a human-readable text format.
180
181           ·  short: Emit shorter, human-readable text messages.
182
183           ·  json: Emit JSON messages to stdout. See the reference
184               <https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
185               for more details.
186
187           ·  json-diagnostic-short: Ensure the rendered field of JSON
188               messages contains the "short" rendering from rustc.
189
190           ·  json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
191               messages contains embedded ANSI color codes for respecting
192               rustc's default color scheme.
193
194           ·  json-render-diagnostics: Instruct Cargo to not include rustc
195               diagnostics in in JSON messages printed, but instead Cargo
196               itself should render the JSON diagnostics coming from rustc.
197               Cargo's own JSON diagnostics and others coming from rustc are
198               still emitted.
199
200   Manifest Options
201       --manifest-path path
202           Path to the Cargo.toml file. By default, Cargo searches for the
203           Cargo.toml file in the current directory or any parent directory.
204
205       --frozen, --locked
206           Either of these flags requires that the Cargo.lock file is
207           up-to-date. If the lock file is missing, or it needs to be updated,
208           Cargo will exit with an error. The --frozen flag also prevents
209           Cargo from attempting to access the network to determine if it is
210           out-of-date.
211
212           These may be used in environments where you want to assert that the
213           Cargo.lock file is up-to-date (such as a CI build) or want to avoid
214           network access.
215
216       --offline
217           Prevents Cargo from accessing the network for any reason. Without
218           this flag, Cargo will stop with an error if it needs to access the
219           network and the network is not available. With this flag, Cargo
220           will attempt to proceed without the network if possible.
221
222           Beware that this may result in different dependency resolution than
223           online mode. Cargo will restrict itself to crates that are
224           downloaded locally, even if there might be a newer version as
225           indicated in the local copy of the index. See the cargo-fetch(1)
226           command to download dependencies before going offline.
227
228           May also be specified with the net.offline config value
229           <https://doc.rust-lang.org/cargo/reference/config.html>.
230
231   Common Options
232       +toolchain
233           If Cargo has been installed with rustup, and the first argument to
234           cargo begins with +, it will be interpreted as a rustup toolchain
235           name (such as +stable or +nightly). See the rustup documentation
236           <https://rust-lang.github.io/rustup/overrides.html> for more
237           information about how toolchain overrides work.
238
239       -h, --help
240           Prints help information.
241
242       -Z flag
243           Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
244           details.
245
246   Miscellaneous Options
247       -j N, --jobs N
248           Number of parallel jobs to run. May also be specified with the
249           build.jobs config value
250           <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
251           to the number of CPUs.
252

PROFILES

254       Profiles may be used to configure compiler options such as optimization
255       levels and debug settings. See the reference
256       <https://doc.rust-lang.org/cargo/reference/profiles.html> for more
257       details.
258
259       Profile selection depends on the target and crate being built. By
260       default the dev or test profiles are used. If the --release flag is
261       given, then the release or bench profiles are used.
262
263
264       ┌────────────────────┬─────────────────┬───────────────────┐
265       │Target              │ Default Profile │ --release Profile │
266       ├────────────────────┼─────────────────┼───────────────────┤
267       │lib, bin, example   │ dev             │ release           │
268       ├────────────────────┼─────────────────┼───────────────────┤
269       │test, bench, or any │ test            │ bench             │
270       │target in "test" or │                 │                   │
271       │"bench" mode        │                 │                   │
272       └────────────────────┴─────────────────┴───────────────────┘
273
274       Dependencies use the dev/release profiles.
275

ENVIRONMENT

277       See the reference
278       <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
279       for details on environment variables that Cargo reads.
280

EXIT STATUS

282       ·  0: Cargo succeeded.
283
284       ·  101: Cargo failed to complete.
285

EXAMPLES

287        1. Check if your package (not including dependencies) uses unsafe
288           code:
289
290               cargo rustc --lib -- -D unsafe-code
291
292        2. Try an experimental flag on the nightly compiler, such as this
293           which prints the size of every type:
294
295               cargo rustc --lib -- -Z print-type-sizes
296