Struct CompilerInterface 

pub(crate) struct CompilerInterface<'tcx> {
    pub tables: RefCell<Tables<'tcx, BridgeTys>>,
    pub cx: RefCell<CompilerCtxt<'tcx, BridgeTys>>,
}

Public API for querying compiler information.

All queries are delegated to rustc_public_bridge::context::CompilerCtxt that provides similar APIs but based on internal rustc constructs.

Do not use this directly. This is currently used in the macro expansion.

Fields

tables: RefCell<Tables<'tcx, BridgeTys>>

cx: RefCell<CompilerCtxt<'tcx, BridgeTys>>

Implementations

impl<'tcx> CompilerInterface<'tcx>

pub(crate) fn entry_fn(&self) -> Option<CrateItem>

pub(crate) fn all_local_items(&self) -> CrateItems

Retrieve all items of the local crate that have a MIR associated with them.

pub(crate) fn mir_body(&self, item: DefId) -> Body

Retrieve the body of a function. This function will panic if the body is not available.

pub(crate) fn has_body(&self, item: DefId) -> bool

Check whether the body of a function is available.

pub(crate) fn foreign_modules( &self, crate_num: CrateNum, ) -> Vec<ForeignModuleDef>

pub(crate) fn crate_functions(&self, crate_num: CrateNum) -> Vec<FnDef>

Retrieve all functions defined in this crate.

pub(crate) fn crate_statics(&self, crate_num: CrateNum) -> Vec<StaticDef>

Retrieve all static items defined in this crate.

pub(crate) fn foreign_module(&self, mod_def: ForeignModuleDef) -> ForeignModule

pub(crate) fn foreign_items(&self, mod_def: ForeignModuleDef) -> Vec<ForeignDef>

pub(crate) fn all_trait_decls(&self) -> TraitDecls

pub(crate) fn trait_decls(&self, crate_num: CrateNum) -> TraitDecls

pub(crate) fn trait_decl(&self, trait_def: &TraitDef) -> TraitDecl

pub(crate) fn all_trait_impls(&self) -> ImplTraitDecls

pub(crate) fn trait_impls(&self, crate_num: CrateNum) -> ImplTraitDecls

pub(crate) fn trait_impl(&self, trait_impl: &ImplDef) -> ImplTrait

pub(crate) fn generics_of(&self, def_id: DefId) -> Generics

pub(crate) fn predicates_of(&self, def_id: DefId) -> GenericPredicates

pub(crate) fn explicit_predicates_of(&self, def_id: DefId) -> GenericPredicates

pub(crate) fn local_crate(&self) -> Crate

Get information about the local crate.

pub(crate) fn external_crates(&self) -> Vec<Crate>

Retrieve a list of all external crates.

pub(crate) fn find_crates(&self, name: &str) -> Vec<Crate>

Find a crate with the given name.

pub(crate) fn def_name(&self, def_id: DefId, trimmed: bool) -> Symbol

Returns the name of given DefId.

pub(crate) fn tool_attrs( &self, def_id: DefId, attr: &[Symbol], ) -> Vec<Attribute>

Return registered tool attributes with the given attribute name.

FIXME(jdonszelmann): may panic on non-tool attributes. After more attribute work, non-tool attributes will simply return an empty list.

Single segmented name like #[clippy] is specified as &["clippy".to_string()]. Multi-segmented name like #[rustfmt::skip] is specified as &["rustfmt".to_string(), "skip".to_string()].

pub(crate) fn all_tool_attrs(&self, def_id: DefId) -> Vec<Attribute>

Get all tool attributes of a definition.

pub(crate) fn span_to_string(&self, span: Span) -> String

Returns printable, human readable form of Span.

pub(crate) fn get_filename(&self, span: &Span) -> Filename

Return filename from given Span, for diagnostic purposes.

pub(crate) fn get_lines(&self, span: &Span) -> LineInfo

Return lines corresponding to this Span.

pub(crate) fn item_kind(&self, item: CrateItem) -> ItemKind

Returns the kind of given DefId.

pub(crate) fn is_foreign_item(&self, item: DefId) -> bool

Returns whether this is a foreign item.

pub(crate) fn foreign_item_kind(&self, def: ForeignDef) -> ForeignItemKind

Returns the kind of a given foreign item.

pub(crate) fn adt_kind(&self, def: AdtDef) -> AdtKind

Returns the kind of a given algebraic data type.

pub(crate) fn adt_is_box(&self, def: AdtDef) -> bool

Returns if the ADT is a box.

pub(crate) fn adt_is_simd(&self, def: AdtDef) -> bool

Returns whether this ADT is simd.

pub(crate) fn adt_is_cstr(&self, def: AdtDef) -> bool

Returns whether this definition is a C string.

pub(crate) fn adt_repr(&self, def: AdtDef) -> ReprOptions

Returns the representation options for this ADT

pub(crate) fn fn_sig(&self, def: FnDef, args: &GenericArgs) -> PolyFnSig

Retrieve the function signature for the given generic arguments.

pub(crate) fn intrinsic(&self, item: DefId) -> Option<IntrinsicDef>

Retrieve the intrinsic definition if the item corresponds one.

pub(crate) fn intrinsic_name(&self, def: IntrinsicDef) -> Symbol

Retrieve the plain function name of an intrinsic.

pub(crate) fn closure_sig(&self, args: &GenericArgs) -> PolyFnSig

Retrieve the closure signature for the given generic arguments.

pub(crate) fn adt_variants_len(&self, def: AdtDef) -> usize

The number of variants in this ADT.

pub(crate) fn adt_discr_for_variant( &self, adt: AdtDef, variant: VariantIdx, ) -> Discr

Discriminant for a given variant index of AdtDef.

pub(crate) fn coroutine_discr_for_variant( &self, coroutine: CoroutineDef, args: &GenericArgs, variant: VariantIdx, ) -> Discr

Discriminant for a given variand index and args of a coroutine.

pub(crate) fn variant_name(&self, def: VariantDef) -> Symbol

The name of a variant.

pub(crate) fn variant_fields(&self, def: VariantDef) -> Vec<FieldDef>

pub(crate) fn eval_target_usize( &self, mir_const: &MirConst, ) -> Result<u64, Error>

Evaluate constant as a target usize.

pub(crate) fn eval_target_usize_ty( &self, ty_const: &TyConst, ) -> Result<u64, Error>

pub(crate) fn try_new_const_zst(&self, ty: Ty) -> Result<MirConst, Error>

Create a new zero-sized constant.

pub(crate) fn new_const_str(&self, value: &str) -> MirConst

Create a new constant that represents the given string value.

pub(crate) fn new_const_bool(&self, value: bool) -> MirConst

Create a new constant that represents the given boolean value.

pub(crate) fn try_new_const_uint( &self, value: u128, uint_ty: UintTy, ) -> Result<MirConst, Error>

Create a new constant that represents the given value.

pub(crate) fn try_new_ty_const_uint( &self, value: u128, uint_ty: UintTy, ) -> Result<TyConst, Error>

pub(crate) fn new_rigid_ty(&self, kind: RigidTy) -> Ty

Create a new type from the given kind.

pub(crate) fn new_box_ty(&self, ty: Ty) -> Ty

Create a new box type, Box<T>, for the given inner type T.

pub(crate) fn def_ty(&self, item: DefId) -> Ty

Returns the type of given crate item.

pub(crate) fn def_ty_with_args(&self, item: DefId, args: &GenericArgs) -> Ty

Returns the type of given definition instantiated with the given arguments.

pub(crate) fn mir_const_pretty(&self, cnst: &MirConst) -> String

Returns literal value of a const as a string.

pub(crate) fn span_of_an_item(&self, def_id: DefId) -> Span

Span of an item.

pub(crate) fn ty_const_pretty(&self, ct: TyConstId) -> String

pub(crate) fn ty_pretty(&self, ty: Ty) -> String

Obtain the representation of a type.

pub(crate) fn ty_kind(&self, ty: Ty) -> TyKind

Obtain the kind of a type.

pub(crate) fn rigid_ty_discriminant_ty(&self, ty: &RigidTy) -> Ty

Get the discriminant Ty for this Ty if there’s one.

pub(crate) fn instance_body(&self, instance: InstanceDef) -> Option<Body>

Get the body of an Instance which is already monomorphized.

pub(crate) fn instance_ty(&self, instance: InstanceDef) -> Ty

Get the instance type with generic instantiations applied and lifetimes erased.

pub(crate) fn instance_args(&self, def: InstanceDef) -> GenericArgs

Get the instantiation types.

pub(crate) fn instance_def_id(&self, instance: InstanceDef) -> DefId

Get the instance.

pub(crate) fn instance_mangled_name(&self, instance: InstanceDef) -> Symbol

Get the instance mangled name.

pub(crate) fn is_empty_drop_shim(&self, def: InstanceDef) -> bool

Check if this is an empty DropGlue shim.

pub(crate) fn mono_instance(&self, def_id: DefId) -> Instance

Convert a non-generic crate item into an instance. This function will panic if the item is generic.

pub(crate) fn requires_monomorphization(&self, def_id: DefId) -> bool

Item requires monomorphization.

pub(crate) fn resolve_instance( &self, def: FnDef, args: &GenericArgs, ) -> Option<Instance>

Resolve an instance from the given function definition and generic arguments.

pub(crate) fn resolve_drop_in_place(&self, ty: Ty) -> Instance

Resolve an instance for drop_in_place for the given type.

pub(crate) fn resolve_for_fn_ptr( &self, def: FnDef, args: &GenericArgs, ) -> Option<Instance>

Resolve instance for a function pointer.

pub(crate) fn resolve_closure( &self, def: ClosureDef, args: &GenericArgs, kind: ClosureKind, ) -> Option<Instance>

Resolve instance for a closure with the requested type.

pub(crate) fn eval_static_initializer( &self, def: StaticDef, ) -> Result<Allocation, Error>

Evaluate a static’s initializer.

pub(crate) fn eval_instance( &self, def: InstanceDef, const_ty: Ty, ) -> Result<Allocation, Error>

Try to evaluate an instance into a constant.

pub(crate) fn global_alloc(&self, id: AllocId) -> GlobalAlloc

Retrieve global allocation for the given allocation ID.

pub(crate) fn vtable_allocation( &self, global_alloc: &GlobalAlloc, ) -> Option<AllocId>

Retrieve the id for the virtual table.

pub(crate) fn krate(&self, def_id: DefId) -> Crate

pub(crate) fn instance_name(&self, def: InstanceDef, trimmed: bool) -> Symbol

pub(crate) fn target_info(&self) -> MachineInfo

Return information about the target machine.

pub(crate) fn instance_abi(&self, def: InstanceDef) -> Result<FnAbi, Error>

Get an instance ABI.

pub(crate) fn fn_ptr_abi(&self, fn_ptr: PolyFnSig) -> Result<FnAbi, Error>

Get the ABI of a function pointer.

pub(crate) fn ty_layout(&self, ty: Ty) -> Result<Layout, Error>

Get the layout of a type.

pub(crate) fn layout_shape(&self, id: Layout) -> LayoutShape

Get the layout shape.

pub(crate) fn place_pretty(&self, place: &Place) -> String

Get a debug string representation of a place.

pub(crate) fn binop_ty(&self, bin_op: BinOp, rhs: Ty, lhs: Ty) -> Ty

Get the resulting type of binary operation.

pub(crate) fn unop_ty(&self, un_op: UnOp, arg: Ty) -> Ty

Get the resulting type of unary operation.

pub(crate) fn associated_items(&self, def_id: DefId) -> AssocItems

Get all associated items of a definition.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 472 bytes