stable_mir::compiler_interface

Trait Context

source 
pub trait Context {

Show 83 methods    // Required methods
    fn entry_fn(&self) -> Option<CrateItem>;
    fn all_local_items(&self) -> CrateItems;
    fn mir_body(&self, item: DefId) -> Body;
    fn has_body(&self, item: DefId) -> bool;
    fn foreign_modules(&self, crate_num: CrateNum) -> Vec<ForeignModuleDef>;
    fn foreign_module(&self, mod_def: ForeignModuleDef) -> ForeignModule;
    fn foreign_items(&self, mod_def: ForeignModuleDef) -> Vec<ForeignDef>;
    fn all_trait_decls(&self) -> TraitDecls;
    fn trait_decls(&self, crate_num: CrateNum) -> TraitDecls;
    fn trait_decl(&self, trait_def: &TraitDef) -> TraitDecl;
    fn all_trait_impls(&self) -> ImplTraitDecls;
    fn trait_impls(&self, crate_num: CrateNum) -> ImplTraitDecls;
    fn trait_impl(&self, trait_impl: &ImplDef) -> ImplTrait;
    fn generics_of(&self, def_id: DefId) -> Generics;
    fn predicates_of(&self, def_id: DefId) -> GenericPredicates;
    fn explicit_predicates_of(&self, def_id: DefId) -> GenericPredicates;
    fn local_crate(&self) -> Crate;
    fn external_crates(&self) -> Vec<Crate>;
    fn find_crates(&self, name: &str) -> Vec<Crate>;
    fn def_name(&self, def_id: DefId, trimmed: bool) -> Symbol;
    fn get_attrs_by_path(
        &self,
        def_id: DefId,
        attr: &[Symbol],
    ) -> Vec<Attribute>;
    fn get_all_attrs(&self, def_id: DefId) -> Vec<Attribute>;
    fn span_to_string(&self, span: Span) -> String;
    fn get_filename(&self, span: &Span) -> Filename;
    fn get_lines(&self, span: &Span) -> LineInfo;
    fn item_kind(&self, item: CrateItem) -> ItemKind;
    fn is_foreign_item(&self, item: DefId) -> bool;
    fn foreign_item_kind(&self, def: ForeignDef) -> ForeignItemKind;
    fn adt_kind(&self, def: AdtDef) -> AdtKind;
    fn adt_is_box(&self, def: AdtDef) -> bool;
    fn adt_is_simd(&self, def: AdtDef) -> bool;
    fn adt_is_cstr(&self, def: AdtDef) -> bool;
    fn fn_sig(&self, def: FnDef, args: &GenericArgs) -> PolyFnSig;
    fn intrinsic(&self, item: DefId) -> Option<IntrinsicDef>;
    fn intrinsic_name(&self, def: IntrinsicDef) -> Symbol;
    fn closure_sig(&self, args: &GenericArgs) -> PolyFnSig;
    fn adt_variants_len(&self, def: AdtDef) -> usize;
    fn variant_name(&self, def: VariantDef) -> Symbol;
    fn variant_fields(&self, def: VariantDef) -> Vec<FieldDef>;
    fn eval_target_usize(&self, cnst: &MirConst) -> Result<u64, Error>;
    fn eval_target_usize_ty(&self, cnst: &TyConst) -> Result<u64, Error>;
    fn try_new_const_zst(&self, ty: Ty) -> Result<MirConst, Error>;
    fn new_const_str(&self, value: &str) -> MirConst;
    fn new_const_bool(&self, value: bool) -> MirConst;
    fn try_new_const_uint(
        &self,
        value: u128,
        uint_ty: UintTy,
    ) -> Result<MirConst, Error>;
    fn try_new_ty_const_uint(
        &self,
        value: u128,
        uint_ty: UintTy,
    ) -> Result<TyConst, Error>;
    fn new_rigid_ty(&self, kind: RigidTy) -> Ty;
    fn new_box_ty(&self, ty: Ty) -> Ty;
    fn def_ty(&self, item: DefId) -> Ty;
    fn def_ty_with_args(&self, item: DefId, args: &GenericArgs) -> Ty;
    fn mir_const_pretty(&self, cnst: &MirConst) -> String;
    fn span_of_an_item(&self, def_id: DefId) -> Span;
    fn ty_const_pretty(&self, ct: TyConstId) -> String;
    fn ty_pretty(&self, ty: Ty) -> String;
    fn ty_kind(&self, ty: Ty) -> TyKind;
    fn rigid_ty_discriminant_ty(&self, ty: &RigidTy) -> Ty;
    fn instance_body(&self, instance: InstanceDef) -> Option<Body>;
    fn instance_ty(&self, instance: InstanceDef) -> Ty;
    fn instance_args(&self, def: InstanceDef) -> GenericArgs;
    fn instance_def_id(&self, instance: InstanceDef) -> DefId;
    fn instance_mangled_name(&self, instance: InstanceDef) -> Symbol;
    fn is_empty_drop_shim(&self, def: InstanceDef) -> bool;
    fn is_empty_async_drop_ctor_shim(&self, def: InstanceDef) -> bool;
    fn mono_instance(&self, def_id: DefId) -> Instance;
    fn requires_monomorphization(&self, def_id: DefId) -> bool;
    fn resolve_instance(
        &self,
        def: FnDef,
        args: &GenericArgs,
    ) -> Option<Instance>;
    fn resolve_drop_in_place(&self, ty: Ty) -> Instance;
    fn resolve_for_fn_ptr(
        &self,
        def: FnDef,
        args: &GenericArgs,
    ) -> Option<Instance>;
    fn resolve_closure(
        &self,
        def: ClosureDef,
        args: &GenericArgs,
        kind: ClosureKind,
    ) -> Option<Instance>;
    fn eval_static_initializer(
        &self,
        def: StaticDef,
    ) -> Result<Allocation, Error>;
    fn eval_instance(
        &self,
        def: InstanceDef,
        const_ty: Ty,
    ) -> Result<Allocation, Error>;
    fn global_alloc(&self, id: AllocId) -> GlobalAlloc;
    fn vtable_allocation(&self, global_alloc: &GlobalAlloc) -> Option<AllocId>;
    fn krate(&self, def_id: DefId) -> Crate;
    fn instance_name(&self, def: InstanceDef, trimmed: bool) -> Symbol;
    fn target_info(&self) -> MachineInfo;
    fn instance_abi(&self, def: InstanceDef) -> Result<FnAbi, Error>;
    fn fn_ptr_abi(&self, fn_ptr: PolyFnSig) -> Result<FnAbi, Error>;
    fn ty_layout(&self, ty: Ty) -> Result<Layout, Error>;
    fn layout_shape(&self, id: Layout) -> LayoutShape;
    fn place_pretty(&self, place: &Place) -> String;
    fn binop_ty(&self, bin_op: BinOp, rhs: Ty, lhs: Ty) -> Ty;
    fn unop_ty(&self, un_op: UnOp, arg: Ty) -> Ty;

}
Expand description

This trait defines the interface between stable_mir and the Rust compiler. Do not use this directly.

Required Methods§

source

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

source

fn all_local_items(&self) -> CrateItems

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

source

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

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

source

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

Check whether the body of a function is available.

source

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

source

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

source

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

source

fn all_trait_decls(&self) -> TraitDecls

source

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

source

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

source

fn all_trait_impls(&self) -> ImplTraitDecls

source

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

source

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

source

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

source

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

source

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

source

fn local_crate(&self) -> Crate

Get information about the local crate.

source

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

Retrieve a list of all external crates.

source

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

Find a crate with the given name.

source

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

Returns the name of given DefId

source

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

Return attributes with the given attribute name.

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

source

fn get_all_attrs(&self, def_id: DefId) -> Vec<Attribute>

Get all attributes of a definition.

source

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

Returns printable, human readable form of Span

source

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

Return filename from given Span, for diagnostic purposes

source

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

Return lines corresponding to this Span

source

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

Returns the kind of given DefId

source

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

Returns whether this is a foreign item.

source

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

Returns the kind of a given foreign item.

source

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

Returns the kind of a given algebraic data type

source

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

Returns if the ADT is a box.

source

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

Returns whether this ADT is simd.

source

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

Returns whether this definition is a C string.

source

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

Retrieve the function signature for the given generic arguments.

source

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

Retrieve the intrinsic definition if the item corresponds one.

source

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

Retrieve the plain function name of an intrinsic.

source

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

Retrieve the closure signature for the given generic arguments.

source

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

The number of variants in this ADT.

source

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

The name of a variant.

source

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

source

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

Evaluate constant as a target usize.

source

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

source

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

Create a new zero-sized constant.

source

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

Create a new constant that represents the given string value.

source

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

Create a new constant that represents the given boolean value.

source

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

Create a new constant that represents the given value.

source

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

source

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

Create a new type from the given kind.

source

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

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

source

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

Returns the type of given crate item.

source

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

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

source

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

Returns literal value of a const as a string.

source

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

Span of an item

source

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

source

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

Obtain the representation of a type.

source

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

Obtain the representation of a type.

source

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

source

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

Get the body of an Instance which is already monomorphized.

source

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

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

source

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

Get the instantiation types.

source

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

Get the instance.

source

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

Get the instance mangled name.

source

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

Check if this is an empty DropGlue shim.

source

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

Check if this is an empty AsyncDropGlueCtor shim.

source

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.

source

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

Item requires monomorphization.

source

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

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

source

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

Resolve an instance for drop_in_place for the given type.

source

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

Resolve instance for a function pointer.

source

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

Resolve instance for a closure with the requested type.

source

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

Evaluate a static’s initializer.

source

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

Try to evaluate an instance into a constant.

source

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

Retrieve global allocation for the given allocation ID.

source

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

Retrieve the id for the virtual table.

source

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

source

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

source

fn target_info(&self) -> MachineInfo

Return information about the target machine.

source

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

Get an instance ABI.

source

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

Get the ABI of a function pointer.

source

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

Get the layout of a type.

source

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

Get the layout shape.

source

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

Get a debug string representation of a place.

source

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

Get the resulting type of binary operation.

source

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

Get the resulting type of unary operation.

Implementors§