Enum rustc_borrowck::diagnostics::UseSpans

pub(crate) enum UseSpans<'tcx> {
    ClosureUse {
        generator_kind: Option<GeneratorKind>,
        args_span: Span,
        capture_kind_span: Span,
        path_span: Span,
    },
    FnSelfUse {
        var_span: Span,
        fn_call_span: Span,
        fn_span: Span,
        kind: CallKind<'tcx>,
    },
    PatUse(Span),
    OtherUse(Span),
}

The span(s) associated to a use of a place.

Variants

ClosureUse

Fields

generator_kind: Option<GeneratorKind>

This is true if the captured variable was from a generator.

args_span: Span

The span of the args of the closure, including the move keyword if it’s present.

capture_kind_span: Span

The span of the use resulting in capture kind Check ty::CaptureInfo for more details

path_span: Span

The span of the use resulting in the captured path Check ty::CaptureInfo for more details

The access is caused by capturing a variable for a closure.

FnSelfUse

Fields

var_span: Span

The span of the variable being moved

fn_call_span: Span

The span of the method call on the variable

fn_span: Span

The definition span of the method being called

kind: CallKind<'tcx>

The access is caused by using a variable as the receiver of a method that takes ‘self’

PatUse(Span)

This access is caused by a match or if let pattern.

OtherUse(Span)

This access has a single span associated to it: common case.

Implementations

impl UseSpans<'_>

pub(crate) fn args_or_use(self) -> Span

pub(crate) fn var_or_use_path_span(self) -> Span

Returns the span of self, in the case of a ClosureUse returns the path_span

pub(crate) fn var_or_use(self) -> Span

Returns the span of self, in the case of a ClosureUse returns the capture_kind_span

pub(crate) fn generator_kind(self) -> Option<GeneratorKind>

pub(crate) fn args_span_label(
    self,
    err: &mut Diagnostic,
    message: impl Into<String>
)

Add a span label to the arguments of the closure, if it exists.

pub(crate) fn var_path_only_subdiag(
    self,
    err: &mut Diagnostic,
    action: InitializationRequiringAction
)

Add a span label to the use of the captured variable, if it exists. only adds label to the path_span

pub(crate) fn var_span_label(
    self,
    err: &mut Diagnostic,
    message: impl Into<String>,
    kind_desc: impl Into<String>
)

Add a span label to the use of the captured variable, if it exists.

pub(crate) fn var_subdiag(
    self,
    err: &mut Diagnostic,
    kind: Option<BorrowKind>,
    f: impl Fn(Option<GeneratorKind>, Span) -> CaptureVarCause
)

Add a subdiagnostic to the use of the captured variable, if it exists.

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

Returns false if this place is not used in a closure.

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

Returns false if this place is not used in a generator.

pub(crate) fn describe(&self) -> &str

Describe the span associated with a use of a place.

pub(crate) fn or_else<F>(self, if_other: F) -> Selfwhere
    F: FnOnce() -> Self,

Trait Implementations

impl<'tcx> Clone for UseSpans<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for UseSpans<'tcx>

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

Formats the value using the given formatter.

impl<'tcx> PartialEq<UseSpans<'tcx>> for UseSpans<'tcx>

fn eq(&self, other: &UseSpans<'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> Copy for UseSpans<'tcx>

impl<'tcx> Eq for UseSpans<'tcx>

impl<'tcx> StructuralEq for UseSpans<'tcx>

impl<'tcx> StructuralPartialEq for UseSpans<'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: 64 bytes

Size for each variant:

• ClosureUse: 56 bytes
• FnSelfUse: 64 bytes
• PatUse: 8 bytes
• OtherUse: 8 bytes