Enum rustc_borrowck::universal_regions::DefiningTy

pub(crate) enum DefiningTy<'tcx> {
    Closure(DefId, GenericArgsRef<'tcx>),
    Coroutine(DefId, GenericArgsRef<'tcx>),
    CoroutineClosure(DefId, GenericArgsRef<'tcx>),
    FnDef(DefId, GenericArgsRef<'tcx>),
    Const(DefId, GenericArgsRef<'tcx>),
    InlineConst(DefId, GenericArgsRef<'tcx>),
}

The “defining type” for this MIR. The key feature of the “defining type” is that it contains the information needed to derive all the universal regions that are in scope as well as the types of the inputs/output from the MIR. In general, early-bound universal regions appear free in the defining type and late-bound regions appear bound in the signature.

Variants

Closure(DefId, GenericArgsRef<'tcx>)

The MIR is a closure. The signature is found via ClosureArgs::closure_sig_ty.

Coroutine(DefId, GenericArgsRef<'tcx>)

The MIR is a coroutine. The signature is that coroutines take no parameters and return the result of ClosureArgs::coroutine_return_ty.

CoroutineClosure(DefId, GenericArgsRef<'tcx>)

The MIR is a special kind of closure that returns coroutines.

See the documentation on CoroutineClosureSignature for details on how to construct the callable signature of the coroutine from its args.

FnDef(DefId, GenericArgsRef<'tcx>)

The MIR is a fn item with the given DefId and args. The signature of the function can be bound then with the fn_sig query.

Const(DefId, GenericArgsRef<'tcx>)

The MIR represents some form of constant. The signature then is that it has no inputs and a single return value, which is the value of the constant.

InlineConst(DefId, GenericArgsRef<'tcx>)

The MIR represents an inline const. The signature has no inputs and a single return value found via InlineConstArgs::ty.

Implementations

impl<'tcx> DefiningTy<'tcx>

pub(crate) fn upvar_tys(self) -> &'tcx List<Ty<'tcx>>

Returns a list of all the upvar types for this MIR. If this is not a closure or coroutine, there are no upvars, and hence it will be an empty list. The order of types in this list will match up with the upvar order in the HIR, typesystem, and MIR.

pub(crate) fn implicit_inputs(self) -> usize

Number of implicit inputs – notably the “environment” parameter for closures – that appear in MIR but not in the user’s code.

pub(crate) fn is_fn_def(&self) -> bool

pub(crate) fn is_const(&self) -> bool

pub(crate) fn def_id(&self) -> DefId

Trait Implementations

impl<'tcx> Clone for DefiningTy<'tcx>

fn clone(&self) -> DefiningTy<'tcx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'tcx> Debug for DefiningTy<'tcx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'tcx> Copy for DefiningTy<'tcx>

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: 24 bytes

Size for each variant:

• Closure: 16 bytes
• Coroutine: 16 bytes
• CoroutineClosure: 16 bytes
• FnDef: 16 bytes
• Const: 16 bytes
• InlineConst: 16 bytes