Struct SmirCtxt

pub struct SmirCtxt<'tcx>(pub RefCell<Tables<'tcx>>);

Provides direct access to rustc’s internal queries.

The crate::stable_mir::compiler_interface::SmirInterface must go through this context to obtain rustc-level information.

Tuple Fields

0: RefCell<Tables<'tcx>>

Implementations

impl<'tcx> SmirCtxt<'tcx>

pub fn target_info(&self) -> MachineInfo

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

pub fn all_local_items(&self) -> CrateItems

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

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

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

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

Check whether the body of a function is available.

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

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

Retrieve all functions defined in this crate.

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

Retrieve all static items defined in this crate.

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

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

pub fn all_trait_decls(&self) -> TraitDecls

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

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

pub fn all_trait_impls(&self) -> ImplTraitDecls

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

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

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

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

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

pub fn local_crate(&self) -> Crate

Get information about the local crate.

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

Retrieve a list of all external crates.

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

Find a crate with the given name.

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

Returns the name of given DefId.

pub 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 fn all_tool_attrs(&self, def_id: DefId) -> Vec<Attribute>

Get all tool attributes of a definition.

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

Returns printable, human readable form of Span.

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

Return filename from given Span, for diagnostic purposes.

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

Return lines corresponding to this Span.

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

Returns the kind of given DefId.

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

Returns whether this is a foreign item.

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

Returns the kind of a given foreign item.

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

Returns the kind of a given algebraic data type.

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

Returns if the ADT is a box.

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

Returns whether this ADT is simd.

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

Returns whether this definition is a C string.

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

Retrieve the function signature for the given generic arguments.

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

Retrieve the intrinsic definition if the item corresponds one.

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

Retrieve the plain function name of an intrinsic.

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

Retrieve the closure signature for the given generic arguments.

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

The number of variants in this ADT.

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

The name of a variant.

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

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

Evaluate constant as a target usize.

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

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

Create a new zero-sized constant.

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

Create a new constant that represents the given string value.

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

Create a new constant that represents the given boolean value.

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

Create a new constant that represents the given value.

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

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

Create a new type from the given kind.

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

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

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

Returns the type of given crate item.

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

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

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

Returns literal value of a const as a string.

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

Span of an item.

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

Obtain the representation of a type.

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

Obtain the representation of a type.

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

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

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

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

Get the body of an Instance which is already monomorphized.

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

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

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

Get the instantiation types.

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

Get an instance ABI.

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

Get the ABI of a function pointer.

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

Get the instance.

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

Get the instance mangled name.

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

Check if this is an empty DropGlue shim.

pub 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 fn requires_monomorphization(&self, def_id: DefId) -> bool

Item requires monomorphization.

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

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

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

Resolve an instance for drop_in_place for the given type.

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

Resolve instance for a function pointer.

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

Resolve instance for a closure with the requested type.

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

Try to evaluate an instance into a constant.

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

Evaluate a static’s initializer.

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

Retrieve global allocation for the given allocation ID.

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

Retrieve the id for the virtual table.

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

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

Retrieve the instance name for diagnostic messages.

This will return the specialized name, e.g., Vec<char>::new.

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

Get the layout of a type.

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

Get the layout shape.

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

Get a debug string representation of a place.

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

Get the resulting type of binary operation.

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

Get the resulting type of unary operation.

pub 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: 464 bytes