1 //! The "main crate" of the Rust compiler. This crate contains common
2 //! type definitions that are used by the other crates in the rustc
3 //! "family". Some prominent examples (note that each of these modules
4 //! has their own README with further details).
6 //! - **HIR.** The "high-level (H) intermediate representation (IR)" is
7 //! defined in the `hir` module.
8 //! - **MIR.** The "mid-level (M) intermediate representation (IR)" is
9 //! defined in the `mir` module. This module contains only the
10 //! *definition* of the MIR; the passes that transform and operate
11 //! on MIR are found in `librustc_mir` crate.
12 //! - **Types.** The internal representation of types used in rustc is
13 //! defined in the `ty` module. This includes the **type context**
14 //! (or `tcx`), which is the central context during most of
15 //! compilation, containing the interners and other things.
16 //! - **Traits.** Trait resolution is implemented in the `traits` module.
17 //! - **Type inference.** The type inference code can be found in the `infer` module;
18 //! this code handles low-level equality and subtyping operations. The
19 //! type check pass in the compiler is found in the `librustc_typeck` crate.
21 //! For more information about how rustc works, see the [rustc guide].
23 //! [rustc guide]: https://rust-lang.github.io/rustc-guide/
27 //! This API is completely unstable and subject to change.
29 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
31 #![deny(rust_2018_idioms)]
32 #![allow(explicit_outlives_requirements)]
34 #![feature(box_patterns)]
35 #![feature(box_syntax)]
36 #![feature(core_intrinsics)]
37 #![feature(drain_filter)]
38 #![cfg_attr(windows, feature(libc))]
39 #![feature(never_type)]
40 #![feature(exhaustive_patterns)]
41 #![feature(extern_types)]
43 #![feature(non_exhaustive)]
44 #![feature(proc_macro_internals)]
45 #![feature(optin_builtin_traits)]
46 #![feature(refcell_replace_swap)]
47 #![feature(rustc_diagnostic_macros)]
48 #![feature(rustc_attrs)]
49 #![feature(slice_patterns)]
50 #![feature(specialization)]
51 #![feature(unboxed_closures)]
52 #![feature(thread_local)]
53 #![feature(trace_macros)]
54 #![feature(trusted_len)]
55 #![feature(vec_remove_item)]
56 #![feature(step_trait)]
57 #![feature(stmt_expr_attributes)]
58 #![feature(integer_atomics)]
60 #![feature(in_band_lifetimes)]
61 #![feature(crate_visibility_modifier)]
63 #![recursion_limit="512"]
65 #[macro_use] extern crate bitflags;
67 #[macro_use] extern crate lazy_static;
68 #[macro_use] extern crate scoped_tls;
71 #[macro_use] extern crate rustc_data_structures;
73 #[macro_use] extern crate log;
74 #[macro_use] extern crate syntax;
76 // FIXME: This import is used by deriving `RustcDecodable` and `RustcEncodable`. Removing this
77 // results in a bunch of "failed to resolve" errors. Hopefully, the compiler moves to serde or
78 // something, and we can get rid of this.
79 #[allow(rust_2018_idioms)]
80 extern crate serialize as rustc_serialize;
82 #[macro_use] extern crate smallvec;
84 // Note that librustc doesn't actually depend on these crates, see the note in
85 // `Cargo.toml` for this crate about why these are here.
86 #[allow(unused_extern_crates)]
88 #[allow(unused_extern_crates)]
94 // N.B., this module needs to be declared first so diagnostics are
95 // registered before they are used.
108 pub mod expr_use_visitor;
111 pub mod dependency_format;
113 pub mod exported_symbols;
116 pub mod lib_features;
119 pub mod mem_categorization;
123 pub mod recursion_limit;
124 pub mod resolve_lifetime;
126 pub mod weak_lang_items;
144 // A private module so that macro-expanded idents like
145 // `::rustc::lint::Lint` will also work in `rustc` itself.
147 // `libstd` uses the same trick.
153 // FIXME(#27438): right now the unit tests of librustc don't refer to any actual
154 // functions generated in librustc_data_structures (all
155 // references are through generic functions), but statics are
156 // referenced from time to time. Due to this bug we won't
157 // actually correctly link in the statics unless we also
158 // reference a function, so be sure to reference a dummy
162 rustc_data_structures::__noop_fix_for_27438();
166 // Build the diagnostics array at the end so that the metadata includes error use sites.
167 __build_diagnostic_array! { librustc, DIAGNOSTICS }