Crate rustc_driver_impl 

The Rust compiler.

Note

This API is completely unstable and subject to change.

Re-exports

pub(crate) use std::fmt::Write as _; 🔒

pub(crate) use rustc_index as _; 🔒

pub(crate) use do_not_use_print as print; 🔒

pub(crate) use do_not_use_print as println; 🔒

pub(crate) use crate::diagnostics::CantEmitMIR; 🔒

pub(crate) use crate::diagnostics::RLinkEmptyVersionNumber; 🔒

pub(crate) use crate::diagnostics::RLinkEncodingVersionMismatch; 🔒

pub(crate) use crate::diagnostics::RLinkRustcVersionMismatch; 🔒

pub(crate) use crate::diagnostics::RLinkWrongFileType; 🔒

pub(crate) use crate::diagnostics::RlinkCorruptFile; 🔒

pub(crate) use crate::diagnostics::RlinkNotAFile; 🔒

pub(crate) use crate::diagnostics::RlinkUnableToRead; 🔒

pub(crate) use crate::diagnostics::UnstableFeatureUsage; 🔒

pub(crate) use std::cmp::max; 🔒

pub(crate) use BTreeMap; 🔒

pub(crate) use BTreeSet; 🔒

pub(crate) use std::ffi::OsString; 🔒

pub(crate) use fs; 🔒

pub(crate) use File; 🔒

pub(crate) use io; 🔒

pub(crate) use IsTerminal; 🔒

pub(crate) use Read; 🔒

pub(crate) use Write; 🔒

pub(crate) use panic; 🔒

pub(crate) use PanicHookInfo; 🔒

pub(crate) use Path; 🔒

pub(crate) use PathBuf; 🔒

pub(crate) use Command; 🔒

pub(crate) use ExitCode; 🔒

pub(crate) use Stdio; 🔒

pub(crate) use Termination; 🔒

pub(crate) use std::sync::OnceLock; 🔒

pub(crate) use AtomicBool; 🔒

pub(crate) use Ordering; 🔒

pub(crate) use std::time::Instant; 🔒

pub(crate) use env; 🔒

pub(crate) use env; 🔒

pub(crate) use str; 🔒

pub(crate) use rustc_ast as ast; 🔒

pub(crate) use rustc_codegen_ssa::traits::CodegenBackend; 🔒

pub(crate) use CodegenError; 🔒

pub(crate) use CompiledModules; 🔒

pub(crate) use TimePassesFormat; 🔒

pub(crate) use get_resident_set_size; 🔒

pub(crate) use print_time_passes_entry; 🔒

pub(crate) use rustc_errors::emitter::stderr_destination; 🔒

pub(crate) use ColorConfig; 🔒

pub(crate) use DiagCtxt; 🔒

pub(crate) use DiagCtxtHandle; 🔒

pub(crate) use ErrCode; 🔒

pub(crate) use PResult; 🔒

pub(crate) use markdown; 🔒

pub(crate) use rustc_feature::find_gated_cfg; 🔒

pub(crate) use rustc_interface::passes::collect_crate_types; 🔒

pub(crate) use util; 🔒

pub(crate) use get_codegen_backend; 🔒

pub(crate) use Linker; 🔒

pub(crate) use create_and_enter_global_ctxt; 🔒

pub(crate) use interface; 🔒

pub(crate) use passes; 🔒

pub(crate) use rustc_lint::unerased_lint_store; 🔒

pub(crate) use Lint; 🔒

pub(crate) use LintId; 🔒

pub(crate) use rustc_metadata::creader::MetadataLoader; 🔒

pub(crate) use rustc_metadata::locator; 🔒

pub(crate) use rustc_middle::ty::TyCtxt; 🔒

pub(crate) use rustc_parse::lexer::StripTokens; 🔒

pub(crate) use new_parser_from_file; 🔒

pub(crate) use new_parser_from_source_str; 🔒

pub(crate) use unwrap_or_emit_fatal; 🔒

pub(crate) use CG_OPTIONS; 🔒

pub(crate) use ErrorOutputType; 🔒

pub(crate) use Input; 🔒

pub(crate) use OptionDesc; 🔒

pub(crate) use OutFileName; 🔒

pub(crate) use OutputType; 🔒

pub(crate) use Sysroot; 🔒

pub(crate) use UnstableOptions; 🔒

pub(crate) use Z_OPTIONS; 🔒

pub(crate) use nightly_options; 🔒

pub(crate) use parse_target_triple; 🔒

pub(crate) use getopts; 🔒

pub(crate) use Matches; 🔒

pub(crate) use rustc_session::output::invalid_output_for_target; 🔒

pub(crate) use EarlyDiagCtxt; 🔒

pub(crate) use Session; 🔒

pub(crate) use config; 🔒

pub(crate) use rustc_span::def_id::LOCAL_CRATE; 🔒

pub(crate) use DUMMY_SP; 🔒

pub(crate) use FileName; 🔒

pub(crate) use CrateType; 🔒

pub(crate) use LintName; 🔒

pub(crate) use rustc_target::json::ToJson; 🔒

pub(crate) use Target; 🔒

pub(crate) use TargetTuple; 🔒

pub(crate) use tracing::trace; 🔒

Modules

allocator 🔒

args

diagnostics 🔒

highlighter

This module provides a syntax highlighter for Rust code. It is used by the rustc --explain command.

pretty

The various pretty-printing routines.

print 🔒

signal_handler 🔒

Signal handler for rustc Primarily used to extract a backtrace from stack overflow

Macros

do_not_use_print 🔒

do_not_use_safe_print 🔒

override_c_allocator_in_binary

This macro overrides the C allocator (i.e., malloc) in final binaries by linking jemalloc with the override feature enabled. The C allocator is used by the default Rust allocator (alloc::System) on Unix targets but not on Windows targets.

version

Prints version information

Structs

TimePassesCallbacks

Enums

Compilation

Whether to stop or continue compilation.

HandledOptions

Constants

DEFAULT_BUG_REPORT_URL

EXIT_FAILURE

Exit status code used for compilation failures and invalid flags.

EXIT_SUCCESS

Exit status code used for successful compilation and help output.

Statics

ICE_COLOR 🔒

ICE_PATH 🔒

USING_INTERNAL_FEATURES

Traits

Callbacks

Functions

catch_fatal_errors

Runs a closure and catches unwinds triggered by fatal errors.

catch_with_exit_code

Variant of catch_fatal_errors for the interface::Result return type that also computes the exit code.

compiler_entrypoint

This is the primary entry point for rustc.

describe_codegen_flags 🔒

describe_flag_categories

Show help for flag categories shared between rustdoc and rustc.

describe_lints

Write to stdout lint command options, together with a list of all available lints

describe_unstable_flags 🔒

dump_feature_usage_metrics 🔒

get_backend_from_raw_matches 🔒

Get the codegen backend based on the raw Matches.

handle_explain 🔒

handle_help

Handle help options in the order they are provided, ignoring other flags. Returns if any options were handled Handled options:

handle_options

Process command line options. Emits messages as appropriate. If compilation should continue, returns a getopts::Matches object parsed from args, otherwise returns None.

ice_path 🔒

ice_path_with_config 🔒

init_logger

This allows tools to enable rust logging without having to magically match rustc’s tracing crate version. In contrast to init_rustc_env_logger it allows you to choose the logger config directly rather than having to set an environment variable.

init_logger_with_additional_layer

This allows tools to enable rust logging without having to magically match rustc’s tracing crate version. In contrast to init_rustc_env_logger, it allows you to choose the logger config directly rather than having to set an environment variable. Moreover, in contrast to init_logger, it allows you to add a custom tracing layer via build_subscriber, for example || Registry::default().with(custom_layer).

init_rustc_env_logger

This allows tools to enable rust logging without having to magically match rustc’s tracing crate version.

install_ctrlc_handler

Install our usual ctrlc handler, which sets rustc_const_eval::CTRL_C_RECEIVED. Making this handler optional lets tools can install a different handler, if they wish.

install_ice_hook

Installs a panic hook that will print the ICE message on unexpected panics.

list_metadata 🔒

main

make_input 🔒

Extract input (string or file and optional path) from matches. This handles reading from stdin if - is provided.

make_output 🔒

Extract output directory and file from matches.

parse_crate_attrs 🔒

print_crate_info

print_flag_list 🔒

print_wall_help 🔒

process_rlink 🔒

report_ice 🔒

Prints the ICE message, including query stack, but without backtrace.

show_colored_md_content 🔒

Prints the markdown content with colored output.

show_md_content_with_pager 🔒

If color is always or auto, try to print pretty (formatted & colorized) markdown. If that fails or color is never, print the raw markdown.

usage 🔒

warn_on_confusing_output_filename_flag 🔒

Warn if -o is used without a space between the flag name and the value and the value is a high-value confusables, e.g. -optimize instead of -o optimize, see issue #142812.