Struct rustc_middle::ty::closure::CaptureInfo

pub struct CaptureInfo<'tcx> {
    pub capture_kind_expr_id: Option<HirId>,
    pub path_expr_id: Option<HirId>,
    pub capture_kind: UpvarCapture<'tcx>,
}

Part of MinCaptureInformationMap; describes the capture kind (&, &mut, move) for a particular capture as well as identifying the part of the source code that triggered this capture to occur.

Fields

capture_kind_expr_id: Option<HirId>

Expr Id pointing to use that resulted in selecting the current capture kind

Eg:

let mut t = (0,1);

let c = || {
    println!("{}",t); // L1
    t.1 = 4; // L2
};

capture_kind_expr_id will point to the use on L2 and path_expr_id will point to the use on L1.

If the user doesn’t enable feature capture_disjoint_fields (RFC 2229) then, it is possible that we don’t see the use of a particular place resulting in capture_kind_expr_id being None. In such case we fallback on uvpars_mentioned for span.

Eg:

let x = 5;

let c = || {
    let _ = x
};

In this example, if capture_disjoint_fields is not set, then x will be captured, but we won’t see it being used during capture analysis, since it’s essentially a discard.

path_expr_id: Option<HirId>

Expr Id pointing to use that resulted the corresponding place being captured

See capture_kind_expr_id for example.

capture_kind: UpvarCapture<'tcx>

Capture mode that was selected

Trait Implementations

impl<'tcx> Clone for CaptureInfo<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for CaptureInfo<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<'tcx>> Decodable<__D> for CaptureInfo<'tcx>

fn decode(__decoder: &mut __D) -> Result<Self, <__D as Decoder>::Error>

impl<'tcx, __E: TyEncoder<'tcx>> Encodable<__E> for CaptureInfo<'tcx>

fn encode(&self, __encoder: &mut __E) -> Result<(), <__E as Encoder>::Error>

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for CaptureInfo<'tcx>

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl<'tcx> PartialEq<CaptureInfo<'tcx>> for CaptureInfo<'tcx>

fn eq(&self, other: &CaptureInfo<'tcx>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CaptureInfo<'tcx>) -> bool

This method tests for !=.

impl<'tcx> TypeFoldable<'tcx> for CaptureInfo<'tcx>

fn super_fold_with<__F: TypeFolder<'tcx>>(self, __folder: &mut __F) -> Self

fn super_visit_with<__F: TypeVisitor<'tcx>>(
    &self,
    __folder: &mut __F
) -> ControlFlow<__F::BreakTy>

fn fold_with<F: TypeFolder<'tcx>>(self, folder: &mut F) -> Self

fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.

impl<'tcx> Copy for CaptureInfo<'tcx>

impl<'tcx> StructuralPartialEq for CaptureInfo<'tcx>