rust/src/librustc/lib.rs

125 lines
3.5 KiB
Rust
Raw Normal View History

//! The "main crate" of the Rust compiler. This crate contains common
//! type definitions that are used by the other crates in the rustc
//! "family". Some prominent examples (note that each of these modules
//! has their own README with further details).
//!
//! - **HIR.** The "high-level (H) intermediate representation (IR)" is
//! defined in the `hir` module.
//! - **MIR.** The "mid-level (M) intermediate representation (IR)" is
//! defined in the `mir` module. This module contains only the
//! *definition* of the MIR; the passes that transform and operate
//! on MIR are found in `librustc_mir` crate.
//! - **Types.** The internal representation of types used in rustc is
//! defined in the `ty` module. This includes the **type context**
//! (or `tcx`), which is the central context during most of
//! compilation, containing the interners and other things.
//! - **Traits.** Trait resolution is implemented in the `traits` module.
//! - **Type inference.** The type inference code can be found in the `infer` module;
//! this code handles low-level equality and subtyping operations. The
//! type check pass in the compiler is found in the `librustc_typeck` crate.
//!
2018-02-25 21:24:14 +00:00
//! For more information about how rustc works, see the [rustc guide].
//!
2018-11-26 21:03:13 +00:00
//! [rustc guide]: https://rust-lang.github.io/rustc-guide/
//!
//! # Note
//!
//! This API is completely unstable and subject to change.
2014-01-08 05:17:52 +00:00
#![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
2011-05-06 02:44:00 +00:00
#![feature(arbitrary_self_types)]
2019-10-08 00:14:42 +00:00
#![feature(bool_to_option)]
#![feature(box_patterns)]
#![feature(box_syntax)]
#![feature(const_fn)]
#![feature(const_transmute)]
2016-06-08 21:16:35 +00:00
#![feature(core_intrinsics)]
2017-12-06 08:25:29 +00:00
#![feature(drain_filter)]
2017-08-14 00:26:14 +00:00
#![cfg_attr(windows, feature(libc))]
#![cfg_attr(bootstrap, feature(never_type))]
#![feature(exhaustive_patterns)]
#![feature(overlapping_marker_traits)]
2018-05-02 06:02:57 +00:00
#![feature(extern_types)]
#![feature(nll)]
#![feature(optin_builtin_traits)]
#![feature(option_expect_none)]
2019-03-21 12:37:31 +00:00
#![feature(range_is_empty)]
2015-04-28 23:36:22 +00:00
#![feature(slice_patterns)]
#![feature(specialization)]
#![feature(unboxed_closures)]
2018-12-04 15:26:34 +00:00
#![feature(thread_local)]
#![feature(trace_macros)]
#![feature(trusted_len)]
#![feature(vec_remove_item)]
2018-12-04 15:26:34 +00:00
#![feature(stmt_expr_attributes)]
#![feature(integer_atomics)]
#![feature(test)]
#![feature(in_band_lifetimes)]
2018-08-04 00:34:23 +00:00
#![feature(crate_visibility_modifier)]
2018-12-03 00:14:35 +00:00
#![feature(log_syntax)]
#![feature(associated_type_bounds)]
#![feature(rustc_attrs)]
#![feature(hash_raw_entry)]
2017-12-06 08:25:29 +00:00
#![recursion_limit="512"]
2015-03-06 23:11:59 +00:00
#[macro_use] extern crate bitflags;
#[macro_use] extern crate scoped_tls;
2017-08-14 00:26:14 +00:00
#[cfg(windows)]
extern crate libc;
2018-12-03 00:14:35 +00:00
#[macro_use] extern crate rustc_macros;
2017-12-06 08:25:29 +00:00
#[macro_use] extern crate rustc_data_structures;
#[macro_use] extern crate log;
#[macro_use] extern crate syntax;
2019-02-05 17:20:45 +00:00
#[macro_use] extern crate smallvec;
2018-08-13 19:15:16 +00:00
#[cfg(test)]
mod tests;
#[macro_use]
mod macros;
2018-12-03 00:14:35 +00:00
#[macro_use]
pub mod query;
#[macro_use]
pub mod arena;
pub mod dep_graph;
2016-03-29 05:50:44 +00:00
pub mod hir;
pub mod ich;
pub mod infer;
pub mod lint;
pub mod middle {
pub mod cstore;
pub mod dependency_format;
pub mod diagnostic_items;
pub mod exported_symbols;
pub mod free_region;
pub mod lib_features;
pub mod lang_items;
pub mod privacy;
pub mod reachable;
pub mod region;
pub mod recursion_limit;
pub mod resolve_lifetime;
pub mod stability;
pub mod weak_lang_items;
2011-04-19 23:40:46 +00:00
}
2016-09-19 20:50:00 +00:00
pub mod mir;
2019-11-29 21:05:28 +00:00
pub use rustc_session as session;
pub mod traits;
pub mod ty;
pub mod util {
pub mod captures;
pub mod common;
pub mod nodemap;
pub mod bug;
2010-08-18 18:34:47 +00:00
}
2019-03-05 18:27:50 +00:00
// Allows macros to refer to this crate as `::rustc`
extern crate self as rustc;