1CARGO-RUSTC(1) General Commands Manual CARGO-RUSTC(1)
2
6 cargo-rustc - Compile the current package, and pass extra options to
7 the compiler
8
10 cargo rustc [options] [-- args]
11
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 See <https://doc.rust-lang.org/rustc/index.html> for documentation on
22 rustc flags.
23 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 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
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 -p spec, --package spec
41 The package to build. See cargo-pkgid(1) for the SPEC format.
42 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 Passing target selection flags will build only the specified targets.
48 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 --lib
55 Build the package's library.
56 --bin name...
58 Build the specified binary. This flag may be specified multiple
59 times and supports common Unix glob patterns.
60 --bins
62 Build all binary targets.
63 --example name...
65 Build the specified example. This flag may be specified multiple
66 times and supports common Unix glob patterns.
67 --examples
69 Build all example targets.
70 --test name...
72 Build the specified integration test. This flag may be specified
73 multiple times and supports common Unix glob patterns.
74 --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 --bench name...
85 Build the specified benchmark. This flag may be specified multiple
86 times and supports common Unix glob patterns.
87 --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 --all-targets
98 Build all targets. This is equivalent to specifying --lib --bins
99 --tests --benches --examples.
100 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 See the features documentation
107 <https://doc.rust-lang.org/cargo/reference/features.html#command-line-feature-options>
108 for more details.
109 --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 --all-features
117 Activate all available features of all selected packages.
118 --no-default-features
120 Do not activate the default feature of the selected packages.
121 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 This may also be specified with the build.target config value
130 <https://doc.rust-lang.org/cargo/reference/config.html>.
131 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 --release
139 Build optimized artifacts with the release profile. See the
140 PROFILES section for details on how this affects profile selection.
141 --ignore-rust-version
143 Build the target even if the selected Rust compiler is older than
144 the required Rust version as configured in the project's
145 rust-version field.
146 Output Options
148 --target-dir directory
149 Directory for all generated artifacts and intermediate files. May
150 also be specified with the CARGO_TARGET_DIR environment variable,
151 or the build.target-dir config value
152 <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
153 to target in the root of the workspace.
154 Display Options
156 -v, --verbose
157 Use verbose output. May be specified twice for "very verbose"
158 output which includes extra output such as dependency warnings and
159 build script output. May also be specified with the term.verbose
160 config value
161 <https://doc.rust-lang.org/cargo/reference/config.html>.
162 -q, --quiet
164 No output printed to stdout.
165 --color when
167 Control when colored output is used. Valid values:
168 • auto (default): Automatically detect if color support is
170 available on the terminal.
171 • always: Always display colors.
173 • never: Never display colors.
175 May also be specified with the term.color config value
177 <https://doc.rust-lang.org/cargo/reference/config.html>.
178 --message-format fmt
180 The output format for diagnostic messages. Can be specified
181 multiple times and consists of comma-separated values. Valid
182 values:
183 • human (default): Display in a human-readable text format.
185 Conflicts with short and json.
186 • short: Emit shorter, human-readable text messages. Conflicts
188 with human and json.
189 • json: Emit JSON messages to stdout. See the reference
191 <https://doc.rust-lang.org/cargo/reference/external-tools.html#json-messages>
192 for more details. Conflicts with human and short.
193 • json-diagnostic-short: Ensure the rendered field of JSON
195 messages contains the "short" rendering from rustc. Cannot be
196 used with human or short.
197 • json-diagnostic-rendered-ansi: Ensure the rendered field of JSON
199 messages contains embedded ANSI color codes for respecting
200 rustc's default color scheme. Cannot be used with human or
201 short.
202 • json-render-diagnostics: Instruct Cargo to not include rustc
204 diagnostics in in JSON messages printed, but instead Cargo
205 itself should render the JSON diagnostics coming from rustc.
206 Cargo's own JSON diagnostics and others coming from rustc are
207 still emitted. Cannot be used with human or short.
208 Manifest Options
210 --manifest-path path
211 Path to the Cargo.toml file. By default, Cargo searches for the
212 Cargo.toml file in the current directory or any parent directory.
213 --frozen, --locked
215 Either of these flags requires that the Cargo.lock file is
216 up-to-date. If the lock file is missing, or it needs to be updated,
217 Cargo will exit with an error. The --frozen flag also prevents
218 Cargo from attempting to access the network to determine if it is
219 out-of-date.
220 These may be used in environments where you want to assert that the
222 Cargo.lock file is up-to-date (such as a CI build) or want to avoid
223 network access.
224 --offline
226 Prevents Cargo from accessing the network for any reason. Without
227 this flag, Cargo will stop with an error if it needs to access the
228 network and the network is not available. With this flag, Cargo
229 will attempt to proceed without the network if possible.
230 Beware that this may result in different dependency resolution than
232 online mode. Cargo will restrict itself to crates that are
233 downloaded locally, even if there might be a newer version as
234 indicated in the local copy of the index. See the cargo-fetch(1)
235 command to download dependencies before going offline.
236 May also be specified with the net.offline config value
238 <https://doc.rust-lang.org/cargo/reference/config.html>.
239 Common Options
241 +toolchain
242 If Cargo has been installed with rustup, and the first argument to
243 cargo begins with +, it will be interpreted as a rustup toolchain
244 name (such as +stable or +nightly). See the rustup documentation
245 <https://rust-lang.github.io/rustup/overrides.html> for more
246 information about how toolchain overrides work.
247 -h, --help
249 Prints help information.
250 -Z flag
252 Unstable (nightly-only) flags to Cargo. Run cargo -Z help for
253 details.
254 Miscellaneous Options
256 -j N, --jobs N
257 Number of parallel jobs to run. May also be specified with the
258 build.jobs config value
259 <https://doc.rust-lang.org/cargo/reference/config.html>. Defaults
260 to the number of CPUs.
261
263 Profiles may be used to configure compiler options such as optimization
264 levels and debug settings. See the reference
265 <https://doc.rust-lang.org/cargo/reference/profiles.html> for more
266 details.
267 Profile selection depends on the target and crate being built. By
269 default the dev or test profiles are used. If the --release flag is
270 given, then the release or bench profiles are used.
271 ┌────────────────────┬─────────────────┬───────────────────┐
274 │Target │ Default Profile │ --release Profile │
275 ├────────────────────┼─────────────────┼───────────────────┤
276 │lib, bin, example │ dev │ release │
277 ├────────────────────┼─────────────────┼───────────────────┤
278 │test, bench, or any │ test │ bench │
279 │target in "test" or │ │ │
280 │"bench" mode │ │ │
281 └────────────────────┴─────────────────┴───────────────────┘
282 Dependencies use the dev/release profiles.
284
286 See the reference
287 <https://doc.rust-lang.org/cargo/reference/environment-variables.html>
288 for details on environment variables that Cargo reads.
289
291 • 0: Cargo succeeded.
292 • 101: Cargo failed to complete.
294
296 1. Check if your package (not including dependencies) uses unsafe
297 code:
298 cargo rustc --lib -- -D unsafe-code
300 2. Try an experimental flag on the nightly compiler, such as this
302 which prints the size of every type:
303 cargo rustc --lib -- -Z print-type-sizes
305
307 cargo(1), cargo-build(1), rustc(1)
308 CARGO-RUSTC(1)