Struct rustc_middle::ty::CapturedPlace

pub struct CapturedPlace<'tcx> {
    pub place: HirPlace<'tcx>,
    pub info: CaptureInfo,
    pub mutability: Mutability,
    pub region: Option<Region<'tcx>>,
}

A composite describing a Place that is captured by a closure.

Fields

place: HirPlace<'tcx>

The Place that is captured.

info: CaptureInfo

CaptureKind and expression(s) that resulted in such capture of place.

mutability: Mutability

Represents if place can be mutated or not.

region: Option<Region<'tcx>>

Region of the resulting reference if the upvar is captured by ref.

Implementations

impl<'tcx> CapturedPlace<'tcx>

pub fn to_string(&self, tcx: TyCtxt<'tcx>) -> String

fn to_symbol(&self, tcx: TyCtxt<'tcx>) -> Symbol

Returns a symbol of the captured upvar, which looks like name__field1__field2.

pub fn get_root_variable(&self) -> HirId

Returns the hir-id of the root variable for the captured place. e.g., if a.b.c was captured, would return the hir-id for a.

pub fn get_closure_local_def_id(&self) -> LocalDefId

Returns the LocalDefId of the closure that captured this Place

pub fn get_path_span(&self, tcx: TyCtxt<'tcx>) -> Span

Return span pointing to use that resulted in selecting the captured path

pub fn get_capture_kind_span(&self, tcx: TyCtxt<'tcx>) -> Span

Return span pointing to use that resulted in selecting the current capture kind

Trait Implementations

impl<'tcx> Clone for CapturedPlace<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for CapturedPlace<'tcx>

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

Formats the value using the given formatter.

impl<'tcx, __D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<__D> for CapturedPlace<'tcx>

fn decode(__decoder: &mut __D) -> Self

impl<'tcx, __E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<__E> for CapturedPlace<'tcx>

fn encode(&self, __encoder: &mut __E)

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

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

impl<'tcx> PartialEq<CapturedPlace<'tcx>> for CapturedPlace<'tcx>

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<'tcx> for CapturedPlace<'tcx>

fn try_fold_with<__F: FallibleTypeFolder<'tcx>>(
    self,
    __folder: &mut __F
) -> Result<Self, __F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

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

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<'tcx> for CapturedPlace<'tcx>

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

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

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 type has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

Return true if this type has regions that are not a part of the type. For example, for<'a> fn(&'a i32) return false, while fn(&'a i32) would return true. The latter can occur when traversing through the former.

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 error_reported(&self) -> Result<(), ErrorGuaranteed>

fn has_non_region_param(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_non_region_infer(&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> StructuralPartialEq for CapturedPlace<'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: 80 bytes