Crate rustc_public

Expand description

The WIP public interface to rustc internals.

§Note

This API is still completely unstable and subject to change.

This crate shall contain all type definitions and APIs that we expect third-party tools to invoke to interact with the compiler.

The goal is to eventually be published on crates.io.

abi
alloc 🔒: Memory allocation implementation for rustc_public.
compiler_interface: Define the interface with the Rust compiler.
crate_def: Module that define a common trait for things that represent a crate definition, such as, a function, a trait, an enum, and any other definitions.
error: When things go wrong, we need some error handling. There are a few different types of errors in rustc_public:
mir
rustc_internal: Export the rustc_internal APIs. Note that this module has no stability guarantees and it is not taken into account for semver. Module that implements the bridge between rustc_public’s IR and internal compiler MIR.
target: Provide information about the machine that this is being compiled into.
ty
unstable 🔒: Module that collects the things that have no stability guarantees.
visitor

bridge_impl 🔒
run: Instantiate and run the compiler with the provided arguments and callback.
run_with_tcx: Instantiate and run the compiler with the provided arguments and callback.

Crate: Holds information about a crate.
CrateItem: Holds information about an item in a crate.
Opaque: A type that provides internal information but that can still be used for debug purpose.

all_local_items: Retrieve all items in the local crate that have a MIR associated with them.
all_trait_decls
all_trait_impls
entry_fn: Return the function where execution starts if the current crate defines that. This is usually main, but could be start if the crate is a no-std crate.
external_crates: Try to find a crate with the given name.
find_crates: Try to find a crate or crates if multiple crates exist from given name.
local_crate: Access to the local crate.
opaque