Struct rustc_mir::borrow_check::diagnostics::outlives_suggestion::OutlivesSuggestionBuilder

pub struct OutlivesSuggestionBuilder {
    constraints_to_add: BTreeMap<RegionVid, Vec<RegionVid>>,
}

Collects information about outlives constraints that needed to be added for a given MIR node corresponding to a function definition.

Adds a help note suggesting adding a where clause with the needed constraints.

Fields

constraints_to_add: BTreeMap<RegionVid, Vec<RegionVid>>

The list of outlives constraints that need to be added. Specifically, we map each free region to all other regions that it must outlive. I will use the shorthand fr: outlived_frs. Not all of these regions will already have names necessarily. Some could be implicit free regions that we inferred. These will need to be given names in the final suggestion message.

Implementations

impl OutlivesSuggestionBuilder

pub(in borrow_check::diagnostics::outlives_suggestion) fn region_name_is_suggestable(
    name: &RegionName
) -> bool

Returns true iff the RegionNameSource is a valid source for an outlives suggestion.

pub(in borrow_check::diagnostics::outlives_suggestion) fn region_vid_to_name(
    &self,
    mbcx: &MirBorrowckCtxt<'_, '_>,
    region: RegionVid
) -> Option<RegionName>

Returns a name for the region if it is suggestable. See region_name_is_suggestable.

pub(in borrow_check::diagnostics::outlives_suggestion) fn compile_all_suggestions(
    &self,
    mbcx: &MirBorrowckCtxt<'_, '_>
) -> SmallVec<[SuggestedConstraint; 2]>

Compiles a list of all suggestions to be printed in the final big suggestion.

pub(crate) fn collect_constraint(
    &mut self,
    fr: RegionVid,
    outlived_fr: RegionVid
)

Add the outlives constraint fr: outlived_fr to the set of constraints we need to suggest.

pub(crate) fn intermediate_suggestion(
    &mut self,
    mbcx: &MirBorrowckCtxt<'_, '_>,
    errci: &ErrorConstraintInfo,
    diag: &mut DiagnosticBuilder<'_>
)

Emit an intermediate note on the given Diagnostic if the involved regions are suggestable.

pub(crate) fn add_suggestion(&self, mbcx: &mut MirBorrowckCtxt<'_, '_>)

If there is a suggestion to emit, add a diagnostic to the buffer. This is the final suggestion including all collected constraints.

Trait Implementations

impl Default for OutlivesSuggestionBuilder

pub fn default() -> OutlivesSuggestionBuilder

Returns the "default value" for a type.