Skip to main content

rustc_middle/
lib.rs

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". The following are some prominent examples.
4//!
5//! - **HIR.** The "high-level (H) intermediate representation (IR)" is
6//!   defined in the [`hir`] module.
7//! - **THIR.** The "typed high-level (H) intermediate representation (IR)"
8//!   is defined in the [`thir`] module.
9//! - **MIR.** The "mid-level (M) intermediate representation (IR)" is
10//!   defined in the [`mir`] module. This module contains only the
11//!   *definition* of the MIR; the passes that transform and operate
12//!   on MIR are found in `rustc_const_eval` crate.
13//! - **Types.** The internal representation of types used in rustc is
14//!   defined in the [`ty`] module. This includes the
15//!   [**type context**][ty::TyCtxt] (or `tcx`), which is the central
16//!   context during most of compilation, containing the interners and
17//!   other things.
18//!
19//! For more information about how rustc works, see the [rustc dev guide].
20//!
21//! [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/
22//!
23//! # Note
24//!
25//! This API is completely unstable and subject to change.
26
27// tidy-alphabetical-start
28#![allow(internal_features)]
29#![allow(rustc::direct_use_of_rustc_type_ir)]
30#![cfg_attr(bootstrap, feature(box_as_ptr))]
31#![cfg_attr(doc, feature(intra_doc_pointers))]
32#![feature(allocator_api)]
33#![feature(associated_type_defaults)]
34#![feature(closure_track_caller)]
35#![feature(const_default)]
36#![feature(const_trait_impl)]
37#![feature(core_intrinsics)]
38#![feature(debug_closure_helpers)]
39#![feature(decl_macro)]
40#![feature(default_field_values)]
41#![feature(deref_patterns)]
42#![feature(discriminant_kind)]
43#![feature(extern_types)]
44#![feature(file_buffered)]
45#![feature(gen_blocks)]
46#![feature(min_specialization)]
47#![feature(negative_impls)]
48#![feature(never_type)]
49#![feature(option_into_flat_iter)]
50#![feature(ptr_alignment_type)]
51#![feature(range_bounds_is_empty)]
52#![feature(rustc_attrs)]
53#![feature(sized_hierarchy)]
54#![feature(trait_alias)]
55#![feature(try_blocks)]
56#![feature(try_trait_v2)]
57#![feature(try_trait_v2_residual)]
58#![feature(try_trait_v2_yeet)]
59#![feature(type_alias_impl_trait)]
60#![feature(yeet_expr)]
61#![recursion_limit = "256"]
62// tidy-alphabetical-end
63
64#[cfg(test)]
65mod tests;
66
67#[macro_use]
68mod macros;
69
70#[macro_use]
71pub mod arena;
72
73pub mod dep_graph;
74pub mod error;
75pub mod hir;
76pub mod hooks;
77pub mod ich;
78pub mod infer;
79pub mod lint;
80pub mod metadata;
81pub mod middle;
82pub mod mir;
83pub mod mono;
84pub mod queries;
85pub mod query;
86pub mod thir;
87pub mod traits;
88pub mod ty;
89pub mod util;
90pub mod verify_ich;
91
92// Allows macros to refer to this crate as `::rustc_middle`
93extern crate self as rustc_middle;