1 // Copyright 2012-2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! Error Reporting Code for the inference engine
13 //! Because of the way inference, and in particular region inference,
14 //! works, it often happens that errors are not detected until far after
15 //! the relevant line of code has been type-checked. Therefore, there is
16 //! an elaborate system to track why a particular constraint in the
17 //! inference graph arose so that we can explain to the user what gave
18 //! rise to a particular error.
20 //! The basis of the system are the "origin" types. An "origin" is the
21 //! reason that a constraint or inference variable arose. There are
22 //! different "origin" enums for different kinds of constraints/variables
23 //! (e.g., `TypeOrigin`, `RegionVariableOrigin`). An origin always has
24 //! a span, but also more information so that we can generate a meaningful
27 //! Having a catalogue of all the different reasons an error can arise is
28 //! also useful for other reasons, like cross-referencing FAQs etc, though
29 //! we are not really taking advantage of this yet.
31 //! # Region Inference
33 //! Region inference is particularly tricky because it always succeeds "in
34 //! the moment" and simply registers a constraint. Then, at the end, we
35 //! can compute the full graph and report errors, so we need to be able to
36 //! store and later report what gave rise to the conflicting constraints.
40 //! Determining whether `T1 <: T2` often involves a number of subtypes and
41 //! subconstraints along the way. A "TypeTrace" is an extended version
42 //! of an origin that traces the types and other values that were being
43 //! compared. It is not necessarily comprehensive (in fact, at the time of
44 //! this writing it only tracks the root values being compared) but I'd
45 //! like to extend it to include significant "waypoints". For example, if
46 //! you are comparing `(T1, T2) <: (T3, T4)`, and the problem is that `T2
47 //! <: T4` fails, I'd like the trace to include enough information to say
48 //! "in the 2nd element of the tuple". Similarly, failures when comparing
49 //! arguments or return types in fn types should be able to cite the
50 //! specific position, etc.
54 //! Of course, there is still a LOT of code in typeck that has yet to be
55 //! ported to this system, and which relies on string concatenation at the
56 //! time of error detection.
58 use self::FreshOrKept::*;
62 use super::SubregionOrigin;
63 use super::RegionVariableOrigin;
64 use super::ValuePairs;
65 use super::region_inference::RegionResolutionError;
66 use super::region_inference::ConcreteFailure;
67 use super::region_inference::SubSupConflict;
68 use super::region_inference::GenericBoundFailure;
69 use super::region_inference::GenericKind;
70 use super::region_inference::ProcessedErrors;
71 use super::region_inference::SameRegions;
73 use std::collections::HashSet;
75 use front::map as ast_map;
77 use rustc_front::print::pprust;
79 use middle::cstore::CrateStore;
81 use middle::def_id::DefId;
82 use middle::infer::{self, TypeOrigin};
85 use middle::ty::{self, Ty, HasTypeFlags};
86 use middle::ty::{Region, ReFree};
87 use middle::ty::error::TypeError;
89 use std::cell::{Cell, RefCell};
90 use std::char::from_u32;
93 use syntax::owned_slice::OwnedSlice;
94 use syntax::codemap::{self, Pos, Span};
95 use syntax::parse::token;
98 impl<'tcx> ty::ctxt<'tcx> {
99 pub fn note_and_explain_region(&self,
103 fn item_scope_tag(item: &hir::Item) -> &'static str {
105 hir::ItemImpl(..) => "impl",
106 hir::ItemStruct(..) => "struct",
107 hir::ItemEnum(..) => "enum",
108 hir::ItemTrait(..) => "trait",
109 hir::ItemFn(..) => "function body",
114 fn explain_span(tcx: &ty::ctxt, heading: &str, span: Span)
115 -> (String, Option<Span>) {
116 let lo = tcx.sess.codemap().lookup_char_pos_adj(span.lo);
117 (format!("the {} at {}:{}", heading, lo.line, lo.col.to_usize()),
121 let (description, span) = match region {
122 ty::ReScope(scope) => {
124 let unknown_scope = || {
125 format!("{}unknown scope: {:?}{}. Please report a bug.",
126 prefix, scope, suffix)
128 let span = match scope.span(&self.region_maps, &self.map) {
130 None => return self.sess.note(&unknown_scope())
132 let tag = match self.map.find(scope.node_id(&self.region_maps)) {
133 Some(ast_map::NodeBlock(_)) => "block",
134 Some(ast_map::NodeExpr(expr)) => match expr.node {
135 hir::ExprCall(..) => "call",
136 hir::ExprMethodCall(..) => "method call",
137 hir::ExprMatch(_, _, hir::MatchSource::IfLetDesugar { .. }) => "if let",
138 hir::ExprMatch(_, _, hir::MatchSource::WhileLetDesugar) => "while let",
139 hir::ExprMatch(_, _, hir::MatchSource::ForLoopDesugar) => "for",
140 hir::ExprMatch(..) => "match",
143 Some(ast_map::NodeStmt(_)) => "statement",
144 Some(ast_map::NodeItem(it)) => item_scope_tag(&*it),
146 return self.sess.span_note(span, &unknown_scope());
149 let scope_decorated_tag = match self.region_maps.code_extent_data(scope) {
150 region::CodeExtentData::Misc(_) => tag,
151 region::CodeExtentData::CallSiteScope { .. } => {
152 "scope of call-site for function"
154 region::CodeExtentData::ParameterScope { .. } => {
155 "scope of parameters for function"
157 region::CodeExtentData::DestructionScope(_) => {
158 new_string = format!("destruction scope surrounding {}", tag);
161 region::CodeExtentData::Remainder(r) => {
162 new_string = format!("block suffix following statement {}",
163 r.first_statement_index);
167 explain_span(self, scope_decorated_tag, span)
170 ty::ReFree(ref fr) => {
171 let prefix = match fr.bound_region {
173 format!("the anonymous lifetime #{} defined on", idx + 1)
175 ty::BrFresh(_) => "an anonymous lifetime defined on".to_owned(),
177 format!("the lifetime {} as defined on",
182 match self.map.find(fr.scope.node_id(&self.region_maps)) {
183 Some(ast_map::NodeBlock(ref blk)) => {
184 let (msg, opt_span) = explain_span(self, "block", blk.span);
185 (format!("{} {}", prefix, msg), opt_span)
187 Some(ast_map::NodeItem(it)) => {
188 let tag = item_scope_tag(&*it);
189 let (msg, opt_span) = explain_span(self, tag, it.span);
190 (format!("{} {}", prefix, msg), opt_span)
193 // this really should not happen, but it does:
195 (format!("{} unknown free region bounded by scope {:?}",
196 prefix, fr.scope), None)
201 ty::ReStatic => ("the static lifetime".to_owned(), None),
203 ty::ReEmpty => ("the empty lifetime".to_owned(), None),
205 ty::ReEarlyBound(ref data) => (data.name.to_string(), None),
207 // FIXME(#13998) ReSkolemized should probably print like
208 // ReFree rather than dumping Debug output on the user.
210 // We shouldn't really be having unification failures with ReVar
211 // and ReLateBound though.
212 ty::ReSkolemized(..) | ty::ReVar(_) | ty::ReLateBound(..) => {
213 (format!("lifetime {:?}", region), None)
216 let message = format!("{}{}{}", prefix, description, suffix);
217 if let Some(span) = span {
218 self.sess.span_note(span, &message);
220 self.sess.note(&message);
225 pub trait ErrorReporting<'tcx> {
226 fn report_region_errors(&self,
227 errors: &Vec<RegionResolutionError<'tcx>>);
229 fn process_errors(&self, errors: &Vec<RegionResolutionError<'tcx>>)
230 -> Vec<RegionResolutionError<'tcx>>;
232 fn report_type_error(&self, trace: TypeTrace<'tcx>, terr: &TypeError<'tcx>);
234 fn check_and_note_conflicting_crates(&self, terr: &TypeError<'tcx>, sp: Span);
236 fn report_and_explain_type_error(&self,
237 trace: TypeTrace<'tcx>,
238 terr: &TypeError<'tcx>);
240 fn values_str(&self, values: &ValuePairs<'tcx>) -> Option<String>;
242 fn expected_found_str<T: fmt::Display + Resolvable<'tcx> + HasTypeFlags>(
244 exp_found: &ty::error::ExpectedFound<T>)
247 fn report_concrete_failure(&self,
248 origin: SubregionOrigin<'tcx>,
252 fn report_generic_bound_failure(&self,
253 origin: SubregionOrigin<'tcx>,
254 kind: GenericKind<'tcx>,
257 fn report_sub_sup_conflict(&self,
258 var_origin: RegionVariableOrigin,
259 sub_origin: SubregionOrigin<'tcx>,
261 sup_origin: SubregionOrigin<'tcx>,
264 fn report_processed_errors(&self,
265 var_origin: &[RegionVariableOrigin],
266 trace_origin: &[(TypeTrace<'tcx>, TypeError<'tcx>)],
267 same_regions: &[SameRegions]);
269 fn give_suggestion(&self, same_regions: &[SameRegions]);
272 trait ErrorReportingHelpers<'tcx> {
273 fn report_inference_failure(&self,
274 var_origin: RegionVariableOrigin);
276 fn note_region_origin(&self,
277 origin: &SubregionOrigin<'tcx>);
279 fn give_expl_lifetime_param(&self,
281 unsafety: hir::Unsafety,
282 constness: hir::Constness,
284 opt_explicit_self: Option<&hir::ExplicitSelf_>,
285 generics: &hir::Generics,
289 impl<'a, 'tcx> ErrorReporting<'tcx> for InferCtxt<'a, 'tcx> {
290 fn report_region_errors(&self,
291 errors: &Vec<RegionResolutionError<'tcx>>) {
292 let p_errors = self.process_errors(errors);
293 let errors = if p_errors.is_empty() { errors } else { &p_errors };
294 for error in errors {
295 match error.clone() {
296 ConcreteFailure(origin, sub, sup) => {
297 self.report_concrete_failure(origin, sub, sup);
300 GenericBoundFailure(kind, param_ty, sub) => {
301 self.report_generic_bound_failure(kind, param_ty, sub);
304 SubSupConflict(var_origin,
306 sup_origin, sup_r) => {
307 self.report_sub_sup_conflict(var_origin,
312 ProcessedErrors(ref var_origins,
314 ref same_regions) => {
315 if !same_regions.is_empty() {
316 self.report_processed_errors(&var_origins[..],
325 // This method goes through all the errors and try to group certain types
326 // of error together, for the purpose of suggesting explicit lifetime
327 // parameters to the user. This is done so that we can have a more
328 // complete view of what lifetimes should be the same.
329 // If the return value is an empty vector, it means that processing
330 // failed (so the return value of this method should not be used)
331 fn process_errors(&self, errors: &Vec<RegionResolutionError<'tcx>>)
332 -> Vec<RegionResolutionError<'tcx>> {
333 debug!("process_errors()");
334 let mut var_origins = Vec::new();
335 let mut trace_origins = Vec::new();
336 let mut same_regions = Vec::new();
337 let mut processed_errors = Vec::new();
338 for error in errors {
339 match error.clone() {
340 ConcreteFailure(origin, sub, sup) => {
341 debug!("processing ConcreteFailure");
342 let trace = match origin {
343 infer::Subtype(trace) => Some(trace),
346 match free_regions_from_same_fn(self.tcx, sub, sup) {
347 Some(ref same_frs) if trace.is_some() => {
348 let trace = trace.unwrap();
349 let terr = TypeError::RegionsDoesNotOutlive(sup,
351 trace_origins.push((trace, terr));
352 append_to_same_regions(&mut same_regions, same_frs);
354 _ => processed_errors.push((*error).clone()),
357 SubSupConflict(var_origin, _, sub_r, _, sup_r) => {
358 debug!("processing SubSupConflict sub: {:?} sup: {:?}", sub_r, sup_r);
359 match free_regions_from_same_fn(self.tcx, sub_r, sup_r) {
360 Some(ref same_frs) => {
361 var_origins.push(var_origin);
362 append_to_same_regions(&mut same_regions, same_frs);
364 None => processed_errors.push((*error).clone()),
367 _ => () // This shouldn't happen
370 if !same_regions.is_empty() {
371 let common_scope_id = same_regions[0].scope_id;
372 for sr in &same_regions {
373 // Since ProcessedErrors is used to reconstruct the function
374 // declaration, we want to make sure that they are, in fact,
375 // from the same scope
376 if sr.scope_id != common_scope_id {
377 debug!("returning empty result from process_errors because
378 {} != {}", sr.scope_id, common_scope_id);
382 let pe = ProcessedErrors(var_origins, trace_origins, same_regions);
383 debug!("errors processed: {:?}", pe);
384 processed_errors.push(pe);
386 return processed_errors;
389 struct FreeRegionsFromSameFn {
390 sub_fr: ty::FreeRegion,
391 sup_fr: ty::FreeRegion,
392 scope_id: ast::NodeId
395 impl FreeRegionsFromSameFn {
396 fn new(sub_fr: ty::FreeRegion,
397 sup_fr: ty::FreeRegion,
398 scope_id: ast::NodeId)
399 -> FreeRegionsFromSameFn {
400 FreeRegionsFromSameFn {
408 fn free_regions_from_same_fn(tcx: &ty::ctxt,
411 -> Option<FreeRegionsFromSameFn> {
412 debug!("free_regions_from_same_fn(sub={:?}, sup={:?})", sub, sup);
413 let (scope_id, fr1, fr2) = match (sub, sup) {
414 (ReFree(fr1), ReFree(fr2)) => {
415 if fr1.scope != fr2.scope {
418 assert!(fr1.scope == fr2.scope);
419 (fr1.scope.node_id(&tcx.region_maps), fr1, fr2)
423 let parent = tcx.map.get_parent(scope_id);
424 let parent_node = tcx.map.find(parent);
426 Some(node) => match node {
427 ast_map::NodeItem(item) => match item.node {
429 Some(FreeRegionsFromSameFn::new(fr1, fr2, scope_id))
433 ast_map::NodeImplItem(..) |
434 ast_map::NodeTraitItem(..) => {
435 Some(FreeRegionsFromSameFn::new(fr1, fr2, scope_id))
440 debug!("no parent node of scope_id {}", scope_id);
446 fn append_to_same_regions(same_regions: &mut Vec<SameRegions>,
447 same_frs: &FreeRegionsFromSameFn) {
448 let scope_id = same_frs.scope_id;
449 let (sub_fr, sup_fr) = (same_frs.sub_fr, same_frs.sup_fr);
450 for sr in &mut *same_regions {
451 if sr.contains(&sup_fr.bound_region)
452 && scope_id == sr.scope_id {
453 sr.push(sub_fr.bound_region);
457 same_regions.push(SameRegions {
459 regions: vec!(sub_fr.bound_region, sup_fr.bound_region)
464 fn report_type_error(&self, trace: TypeTrace<'tcx>, terr: &TypeError<'tcx>) {
465 let expected_found_str = match self.values_str(&trace.values) {
468 return; /* derived error */
472 span_err!(self.tcx.sess, trace.origin.span(), E0308,
478 self.check_and_note_conflicting_crates(terr, trace.origin.span());
481 TypeOrigin::MatchExpressionArm(_, arm_span, source) => match source {
482 hir::MatchSource::IfLetDesugar{..} =>
483 self.tcx.sess.span_note(arm_span, "`if let` arm with an incompatible type"),
484 _ => self.tcx.sess.span_note(arm_span, "match arm with an incompatible type"),
490 /// Adds a note if the types come from similarly named crates
491 fn check_and_note_conflicting_crates(&self, terr: &TypeError<'tcx>, sp: Span) {
492 let report_path_match = |did1: DefId, did2: DefId| {
493 // Only external crates, if either is from a local
494 // module we could have false positives
495 if !(did1.is_local() || did2.is_local()) && did1.krate != did2.krate {
496 let exp_path = self.tcx.with_path(did1,
497 |p| p.map(|x| x.to_string())
498 .collect::<Vec<_>>());
499 let found_path = self.tcx.with_path(did2,
500 |p| p.map(|x| x.to_string())
501 .collect::<Vec<_>>());
502 // We compare strings because PathMod and PathName can be different
503 // for imported and non-imported crates
504 if exp_path == found_path {
505 let crate_name = self.tcx.sess.cstore.crate_name(did1.krate);
506 self.tcx.sess.span_note(sp, &format!("Perhaps two different versions \
507 of crate `{}` are being used?",
513 TypeError::Sorts(ref exp_found) => {
514 // if they are both "path types", there's a chance of ambiguity
515 // due to different versions of the same crate
516 match (&exp_found.expected.sty, &exp_found.found.sty) {
517 (&ty::TyEnum(ref exp_adt, _), &ty::TyEnum(ref found_adt, _)) |
518 (&ty::TyStruct(ref exp_adt, _), &ty::TyStruct(ref found_adt, _)) |
519 (&ty::TyEnum(ref exp_adt, _), &ty::TyStruct(ref found_adt, _)) |
520 (&ty::TyStruct(ref exp_adt, _), &ty::TyEnum(ref found_adt, _)) => {
521 report_path_match(exp_adt.did, found_adt.did);
526 TypeError::Traits(ref exp_found) => {
527 report_path_match(exp_found.expected, exp_found.found);
529 _ => () // FIXME(#22750) handle traits and stuff
533 fn report_and_explain_type_error(&self,
534 trace: TypeTrace<'tcx>,
535 terr: &TypeError<'tcx>) {
536 let span = trace.origin.span();
537 self.report_type_error(trace, terr);
538 self.tcx.note_and_explain_type_err(terr, span);
541 /// Returns a string of the form "expected `{}`, found `{}`", or None if this is a derived
543 fn values_str(&self, values: &ValuePairs<'tcx>) -> Option<String> {
545 infer::Types(ref exp_found) => self.expected_found_str(exp_found),
546 infer::TraitRefs(ref exp_found) => self.expected_found_str(exp_found),
547 infer::PolyTraitRefs(ref exp_found) => self.expected_found_str(exp_found)
551 fn expected_found_str<T: fmt::Display + Resolvable<'tcx> + HasTypeFlags>(
553 exp_found: &ty::error::ExpectedFound<T>)
556 let expected = exp_found.expected.resolve(self);
557 if expected.references_error() {
561 let found = exp_found.found.resolve(self);
562 if found.references_error() {
566 Some(format!("expected `{}`, found `{}`",
571 fn report_generic_bound_failure(&self,
572 origin: SubregionOrigin<'tcx>,
573 bound_kind: GenericKind<'tcx>,
576 // FIXME: it would be better to report the first error message
577 // with the span of the parameter itself, rather than the span
578 // where the error was detected. But that span is not readily
581 let is_warning = match origin {
582 infer::RFC1214Subregion(_) => true,
586 let labeled_user_string = match bound_kind {
587 GenericKind::Param(ref p) =>
588 format!("the parameter type `{}`", p),
589 GenericKind::Projection(ref p) =>
590 format!("the associated type `{}`", p),
594 ty::ReFree(ty::FreeRegion {bound_region: ty::BrNamed(..), ..}) => {
595 // Does the required lifetime have a nice name we can print?
597 is_warning, self.tcx.sess, origin.span(), E0309,
598 "{} may not live long enough", labeled_user_string);
599 self.tcx.sess.fileline_help(
602 "consider adding an explicit lifetime bound `{}: {}`...",
608 // Does the required lifetime have a nice name we can print?
610 is_warning, self.tcx.sess, origin.span(), E0310,
611 "{} may not live long enough", labeled_user_string);
612 self.tcx.sess.fileline_help(
615 "consider adding an explicit lifetime bound `{}: 'static`...",
620 // If not, be less specific.
622 is_warning, self.tcx.sess, origin.span(), E0311,
623 "{} may not live long enough",
624 labeled_user_string);
625 self.tcx.sess.fileline_help(
628 "consider adding an explicit lifetime bound for `{}`",
630 self.tcx.note_and_explain_region(
631 &format!("{} must be valid for ", labeled_user_string),
638 self.tcx.sess.note_rfc_1214(origin.span());
641 self.note_region_origin(&origin);
644 fn report_concrete_failure(&self,
645 origin: SubregionOrigin<'tcx>,
649 infer::RFC1214Subregion(ref suborigin) => {
650 // Ideally, this would be a warning, but it doesn't
651 // seem to come up in practice, since the changes from
652 // RFC1214 mostly trigger errors in type definitions
653 // that don't wind up coming down this path.
654 self.report_concrete_failure((**suborigin).clone(), sub, sup);
656 infer::Subtype(trace) => {
657 let terr = TypeError::RegionsDoesNotOutlive(sup, sub);
658 self.report_and_explain_type_error(trace, &terr);
660 infer::Reborrow(span) => {
661 span_err!(self.tcx.sess, span, E0312,
662 "lifetime of reference outlines \
663 lifetime of borrowed content...");
664 self.tcx.note_and_explain_region(
665 "...the reference is valid for ",
668 self.tcx.note_and_explain_region(
669 "...but the borrowed content is only valid for ",
673 infer::ReborrowUpvar(span, ref upvar_id) => {
674 span_err!(self.tcx.sess, span, E0313,
675 "lifetime of borrowed pointer outlives \
676 lifetime of captured variable `{}`...",
677 self.tcx.local_var_name_str(upvar_id.var_id));
678 self.tcx.note_and_explain_region(
679 "...the borrowed pointer is valid for ",
682 self.tcx.note_and_explain_region(
683 &format!("...but `{}` is only valid for ",
684 self.tcx.local_var_name_str(upvar_id.var_id)),
688 infer::InfStackClosure(span) => {
689 span_err!(self.tcx.sess, span, E0314,
690 "closure outlives stack frame");
691 self.tcx.note_and_explain_region(
692 "...the closure must be valid for ",
695 self.tcx.note_and_explain_region(
696 "...but the closure's stack frame is only valid for ",
700 infer::InvokeClosure(span) => {
701 span_err!(self.tcx.sess, span, E0315,
702 "cannot invoke closure outside of its lifetime");
703 self.tcx.note_and_explain_region(
704 "the closure is only valid for ",
708 infer::DerefPointer(span) => {
709 span_err!(self.tcx.sess, span, E0473,
710 "dereference of reference outside its lifetime");
711 self.tcx.note_and_explain_region(
712 "the reference is only valid for ",
716 infer::FreeVariable(span, id) => {
717 span_err!(self.tcx.sess, span, E0474,
718 "captured variable `{}` does not outlive the enclosing closure",
719 self.tcx.local_var_name_str(id));
720 self.tcx.note_and_explain_region(
721 "captured variable is valid for ",
724 self.tcx.note_and_explain_region(
725 "closure is valid for ",
729 infer::IndexSlice(span) => {
730 span_err!(self.tcx.sess, span, E0475,
731 "index of slice outside its lifetime");
732 self.tcx.note_and_explain_region(
733 "the slice is only valid for ",
737 infer::RelateObjectBound(span) => {
738 span_err!(self.tcx.sess, span, E0476,
739 "lifetime of the source pointer does not outlive \
740 lifetime bound of the object type");
741 self.tcx.note_and_explain_region(
742 "object type is valid for ",
745 self.tcx.note_and_explain_region(
746 "source pointer is only valid for ",
750 infer::RelateParamBound(span, ty) => {
751 span_err!(self.tcx.sess, span, E0477,
752 "the type `{}` does not fulfill the required lifetime",
753 self.ty_to_string(ty));
754 self.tcx.note_and_explain_region(
755 "type must outlive ",
759 infer::RelateRegionParamBound(span) => {
760 span_err!(self.tcx.sess, span, E0478,
761 "lifetime bound not satisfied");
762 self.tcx.note_and_explain_region(
763 "lifetime parameter instantiated with ",
766 self.tcx.note_and_explain_region(
767 "but lifetime parameter must outlive ",
771 infer::RelateDefaultParamBound(span, ty) => {
772 span_err!(self.tcx.sess, span, E0479,
773 "the type `{}` (provided as the value of \
774 a type parameter) is not valid at this point",
775 self.ty_to_string(ty));
776 self.tcx.note_and_explain_region(
777 "type must outlive ",
781 infer::CallRcvr(span) => {
782 span_err!(self.tcx.sess, span, E0480,
783 "lifetime of method receiver does not outlive \
785 self.tcx.note_and_explain_region(
786 "the receiver is only valid for ",
790 infer::CallArg(span) => {
791 span_err!(self.tcx.sess, span, E0481,
792 "lifetime of function argument does not outlive \
794 self.tcx.note_and_explain_region(
795 "the function argument is only valid for ",
799 infer::CallReturn(span) => {
800 span_err!(self.tcx.sess, span, E0482,
801 "lifetime of return value does not outlive \
803 self.tcx.note_and_explain_region(
804 "the return value is only valid for ",
808 infer::Operand(span) => {
809 span_err!(self.tcx.sess, span, E0483,
810 "lifetime of operand does not outlive \
812 self.tcx.note_and_explain_region(
813 "the operand is only valid for ",
817 infer::AddrOf(span) => {
818 span_err!(self.tcx.sess, span, E0484,
819 "reference is not valid at the time of borrow");
820 self.tcx.note_and_explain_region(
821 "the borrow is only valid for ",
825 infer::AutoBorrow(span) => {
826 span_err!(self.tcx.sess, span, E0485,
827 "automatically reference is not valid \
828 at the time of borrow");
829 self.tcx.note_and_explain_region(
830 "the automatic borrow is only valid for ",
834 infer::ExprTypeIsNotInScope(t, span) => {
835 span_err!(self.tcx.sess, span, E0486,
836 "type of expression contains references \
837 that are not valid during the expression: `{}`",
838 self.ty_to_string(t));
839 self.tcx.note_and_explain_region(
840 "type is only valid for ",
844 infer::SafeDestructor(span) => {
845 span_err!(self.tcx.sess, span, E0487,
846 "unsafe use of destructor: destructor might be called \
847 while references are dead");
848 // FIXME (22171): terms "super/subregion" are suboptimal
849 self.tcx.note_and_explain_region(
853 self.tcx.note_and_explain_region(
858 infer::BindingTypeIsNotValidAtDecl(span) => {
859 span_err!(self.tcx.sess, span, E0488,
860 "lifetime of variable does not enclose its declaration");
861 self.tcx.note_and_explain_region(
862 "the variable is only valid for ",
866 infer::ParameterInScope(_, span) => {
867 span_err!(self.tcx.sess, span, E0489,
868 "type/lifetime parameter not in scope here");
869 self.tcx.note_and_explain_region(
870 "the parameter is only valid for ",
874 infer::DataBorrowed(ty, span) => {
875 span_err!(self.tcx.sess, span, E0490,
876 "a value of type `{}` is borrowed for too long",
877 self.ty_to_string(ty));
878 self.tcx.note_and_explain_region("the type is valid for ", sub, "");
879 self.tcx.note_and_explain_region("but the borrow lasts for ", sup, "");
881 infer::ReferenceOutlivesReferent(ty, span) => {
882 span_err!(self.tcx.sess, span, E0491,
883 "in type `{}`, reference has a longer lifetime \
884 than the data it references",
885 self.ty_to_string(ty));
886 self.tcx.note_and_explain_region(
887 "the pointer is valid for ",
890 self.tcx.note_and_explain_region(
891 "but the referenced data is only valid for ",
898 fn report_sub_sup_conflict(&self,
899 var_origin: RegionVariableOrigin,
900 sub_origin: SubregionOrigin<'tcx>,
902 sup_origin: SubregionOrigin<'tcx>,
903 sup_region: Region) {
904 self.report_inference_failure(var_origin);
906 self.tcx.note_and_explain_region(
907 "first, the lifetime cannot outlive ",
911 self.note_region_origin(&sup_origin);
913 self.tcx.note_and_explain_region(
914 "but, the lifetime must be valid for ",
918 self.note_region_origin(&sub_origin);
921 fn report_processed_errors(&self,
922 var_origins: &[RegionVariableOrigin],
923 trace_origins: &[(TypeTrace<'tcx>, TypeError<'tcx>)],
924 same_regions: &[SameRegions]) {
925 for vo in var_origins {
926 self.report_inference_failure(vo.clone());
928 self.give_suggestion(same_regions);
929 for &(ref trace, ref terr) in trace_origins {
930 self.report_and_explain_type_error(trace.clone(), terr);
934 fn give_suggestion(&self, same_regions: &[SameRegions]) {
935 let scope_id = same_regions[0].scope_id;
936 let parent = self.tcx.map.get_parent(scope_id);
937 let parent_node = self.tcx.map.find(parent);
938 let taken = lifetimes_in_scope(self.tcx, scope_id);
939 let life_giver = LifeGiver::with_taken(&taken[..]);
940 let node_inner = match parent_node {
941 Some(ref node) => match *node {
942 ast_map::NodeItem(ref item) => {
944 hir::ItemFn(ref fn_decl, unsafety, constness, _, ref gen, _) => {
945 Some((fn_decl, gen, unsafety, constness,
946 item.name, None, item.span))
951 ast_map::NodeImplItem(item) => {
953 hir::ImplItemKind::Method(ref sig, _) => {
959 Some(&sig.explicit_self.node),
965 ast_map::NodeTraitItem(item) => {
967 hir::MethodTraitItem(ref sig, Some(_)) => {
973 Some(&sig.explicit_self.node),
983 let (fn_decl, generics, unsafety, constness, name, expl_self, span)
984 = node_inner.expect("expect item fn");
985 let rebuilder = Rebuilder::new(self.tcx, fn_decl, expl_self,
986 generics, same_regions, &life_giver);
987 let (fn_decl, expl_self, generics) = rebuilder.rebuild();
988 self.give_expl_lifetime_param(&fn_decl, unsafety, constness, name,
989 expl_self.as_ref(), &generics, span);
993 struct RebuildPathInfo<'a> {
995 // indexes to insert lifetime on path.lifetimes
997 // number of lifetimes we expect to see on the type referred by `path`
998 // (e.g., expected=1 for struct Foo<'a>)
1000 anon_nums: &'a HashSet<u32>,
1001 region_names: &'a HashSet<ast::Name>
1004 struct Rebuilder<'a, 'tcx: 'a> {
1005 tcx: &'a ty::ctxt<'tcx>,
1006 fn_decl: &'a hir::FnDecl,
1007 expl_self_opt: Option<&'a hir::ExplicitSelf_>,
1008 generics: &'a hir::Generics,
1009 same_regions: &'a [SameRegions],
1010 life_giver: &'a LifeGiver,
1011 cur_anon: Cell<u32>,
1012 inserted_anons: RefCell<HashSet<u32>>,
1020 impl<'a, 'tcx> Rebuilder<'a, 'tcx> {
1021 fn new(tcx: &'a ty::ctxt<'tcx>,
1022 fn_decl: &'a hir::FnDecl,
1023 expl_self_opt: Option<&'a hir::ExplicitSelf_>,
1024 generics: &'a hir::Generics,
1025 same_regions: &'a [SameRegions],
1026 life_giver: &'a LifeGiver)
1027 -> Rebuilder<'a, 'tcx> {
1031 expl_self_opt: expl_self_opt,
1033 same_regions: same_regions,
1034 life_giver: life_giver,
1035 cur_anon: Cell::new(0),
1036 inserted_anons: RefCell::new(HashSet::new()),
1041 -> (hir::FnDecl, Option<hir::ExplicitSelf_>, hir::Generics) {
1042 let mut expl_self_opt = self.expl_self_opt.cloned();
1043 let mut inputs = self.fn_decl.inputs.clone();
1044 let mut output = self.fn_decl.output.clone();
1045 let mut ty_params = self.generics.ty_params.clone();
1046 let where_clause = self.generics.where_clause.clone();
1047 let mut kept_lifetimes = HashSet::new();
1048 for sr in self.same_regions {
1049 self.cur_anon.set(0);
1050 self.offset_cur_anon();
1051 let (anon_nums, region_names) =
1052 self.extract_anon_nums_and_names(sr);
1053 let (lifetime, fresh_or_kept) = self.pick_lifetime(®ion_names);
1054 match fresh_or_kept {
1055 Kept => { kept_lifetimes.insert(lifetime.name); }
1058 expl_self_opt = self.rebuild_expl_self(expl_self_opt, lifetime,
1059 &anon_nums, ®ion_names);
1060 inputs = self.rebuild_args_ty(&inputs[..], lifetime,
1061 &anon_nums, ®ion_names);
1062 output = self.rebuild_output(&output, lifetime, &anon_nums, ®ion_names);
1063 ty_params = self.rebuild_ty_params(ty_params, lifetime,
1066 let fresh_lifetimes = self.life_giver.get_generated_lifetimes();
1067 let all_region_names = self.extract_all_region_names();
1068 let generics = self.rebuild_generics(self.generics,
1074 let new_fn_decl = hir::FnDecl {
1077 variadic: self.fn_decl.variadic
1079 (new_fn_decl, expl_self_opt, generics)
1082 fn pick_lifetime(&self,
1083 region_names: &HashSet<ast::Name>)
1084 -> (hir::Lifetime, FreshOrKept) {
1085 if !region_names.is_empty() {
1086 // It's not necessary to convert the set of region names to a
1087 // vector of string and then sort them. However, it makes the
1088 // choice of lifetime name deterministic and thus easier to test.
1089 let mut names = Vec::new();
1090 for rn in region_names {
1091 let lt_name = rn.to_string();
1092 names.push(lt_name);
1095 let name = token::intern(&names[0]);
1096 return (name_to_dummy_lifetime(name), Kept);
1098 return (self.life_giver.give_lifetime(), Fresh);
1101 fn extract_anon_nums_and_names(&self, same_regions: &SameRegions)
1102 -> (HashSet<u32>, HashSet<ast::Name>) {
1103 let mut anon_nums = HashSet::new();
1104 let mut region_names = HashSet::new();
1105 for br in &same_regions.regions {
1108 anon_nums.insert(i);
1110 ty::BrNamed(_, name) => {
1111 region_names.insert(name);
1116 (anon_nums, region_names)
1119 fn extract_all_region_names(&self) -> HashSet<ast::Name> {
1120 let mut all_region_names = HashSet::new();
1121 for sr in self.same_regions {
1122 for br in &sr.regions {
1124 ty::BrNamed(_, name) => {
1125 all_region_names.insert(name);
1134 fn inc_cur_anon(&self, n: u32) {
1135 let anon = self.cur_anon.get();
1136 self.cur_anon.set(anon+n);
1139 fn offset_cur_anon(&self) {
1140 let mut anon = self.cur_anon.get();
1141 while self.inserted_anons.borrow().contains(&anon) {
1144 self.cur_anon.set(anon);
1147 fn inc_and_offset_cur_anon(&self, n: u32) {
1148 self.inc_cur_anon(n);
1149 self.offset_cur_anon();
1152 fn track_anon(&self, anon: u32) {
1153 self.inserted_anons.borrow_mut().insert(anon);
1156 fn rebuild_ty_params(&self,
1157 ty_params: OwnedSlice<hir::TyParam>,
1158 lifetime: hir::Lifetime,
1159 region_names: &HashSet<ast::Name>)
1160 -> OwnedSlice<hir::TyParam> {
1161 ty_params.map(|ty_param| {
1162 let bounds = self.rebuild_ty_param_bounds(ty_param.bounds.clone(),
1166 name: ty_param.name,
1169 default: ty_param.default.clone(),
1170 span: ty_param.span,
1175 fn rebuild_ty_param_bounds(&self,
1176 ty_param_bounds: OwnedSlice<hir::TyParamBound>,
1177 lifetime: hir::Lifetime,
1178 region_names: &HashSet<ast::Name>)
1179 -> OwnedSlice<hir::TyParamBound> {
1180 ty_param_bounds.map(|tpb| {
1182 &hir::RegionTyParamBound(lt) => {
1183 // FIXME -- it's unclear whether I'm supposed to
1184 // substitute lifetime here. I suspect we need to
1185 // be passing down a map.
1186 hir::RegionTyParamBound(lt)
1188 &hir::TraitTyParamBound(ref poly_tr, modifier) => {
1189 let tr = &poly_tr.trait_ref;
1190 let last_seg = tr.path.segments.last().unwrap();
1191 let mut insert = Vec::new();
1192 let lifetimes = last_seg.parameters.lifetimes();
1193 for (i, lt) in lifetimes.iter().enumerate() {
1194 if region_names.contains(<.name) {
1195 insert.push(i as u32);
1198 let rebuild_info = RebuildPathInfo {
1201 expected: lifetimes.len() as u32,
1202 anon_nums: &HashSet::new(),
1203 region_names: region_names
1205 let new_path = self.rebuild_path(rebuild_info, lifetime);
1206 hir::TraitTyParamBound(hir::PolyTraitRef {
1207 bound_lifetimes: poly_tr.bound_lifetimes.clone(),
1208 trait_ref: hir::TraitRef {
1219 fn rebuild_expl_self(&self,
1220 expl_self_opt: Option<hir::ExplicitSelf_>,
1221 lifetime: hir::Lifetime,
1222 anon_nums: &HashSet<u32>,
1223 region_names: &HashSet<ast::Name>)
1224 -> Option<hir::ExplicitSelf_> {
1225 match expl_self_opt {
1226 Some(ref expl_self) => match *expl_self {
1227 hir::SelfRegion(lt_opt, muta, id) => match lt_opt {
1228 Some(lt) => if region_names.contains(<.name) {
1229 return Some(hir::SelfRegion(Some(lifetime), muta, id));
1232 let anon = self.cur_anon.get();
1233 self.inc_and_offset_cur_anon(1);
1234 if anon_nums.contains(&anon) {
1235 self.track_anon(anon);
1236 return Some(hir::SelfRegion(Some(lifetime), muta, id));
1247 fn rebuild_generics(&self,
1248 generics: &hir::Generics,
1249 add: &Vec<hir::Lifetime>,
1250 keep: &HashSet<ast::Name>,
1251 remove: &HashSet<ast::Name>,
1252 ty_params: OwnedSlice<hir::TyParam>,
1253 where_clause: hir::WhereClause)
1255 let mut lifetimes = Vec::new();
1257 lifetimes.push(hir::LifetimeDef { lifetime: *lt,
1258 bounds: Vec::new() });
1260 for lt in &generics.lifetimes {
1261 if keep.contains(<.lifetime.name) ||
1262 !remove.contains(<.lifetime.name) {
1263 lifetimes.push((*lt).clone());
1267 lifetimes: lifetimes,
1268 ty_params: ty_params,
1269 where_clause: where_clause,
1273 fn rebuild_args_ty(&self,
1274 inputs: &[hir::Arg],
1275 lifetime: hir::Lifetime,
1276 anon_nums: &HashSet<u32>,
1277 region_names: &HashSet<ast::Name>)
1279 let mut new_inputs = Vec::new();
1281 let new_ty = self.rebuild_arg_ty_or_output(&*arg.ty, lifetime,
1282 anon_nums, region_names);
1283 let possibly_new_arg = hir::Arg {
1285 pat: arg.pat.clone(),
1288 new_inputs.push(possibly_new_arg);
1293 fn rebuild_output(&self, ty: &hir::FunctionRetTy,
1294 lifetime: hir::Lifetime,
1295 anon_nums: &HashSet<u32>,
1296 region_names: &HashSet<ast::Name>) -> hir::FunctionRetTy {
1298 hir::Return(ref ret_ty) => hir::Return(
1299 self.rebuild_arg_ty_or_output(&**ret_ty, lifetime, anon_nums, region_names)
1301 hir::DefaultReturn(span) => hir::DefaultReturn(span),
1302 hir::NoReturn(span) => hir::NoReturn(span)
1306 fn rebuild_arg_ty_or_output(&self,
1308 lifetime: hir::Lifetime,
1309 anon_nums: &HashSet<u32>,
1310 region_names: &HashSet<ast::Name>)
1312 let mut new_ty = P(ty.clone());
1313 let mut ty_queue = vec!(ty);
1314 while !ty_queue.is_empty() {
1315 let cur_ty = ty_queue.remove(0);
1317 hir::TyRptr(lt_opt, ref mut_ty) => {
1318 let rebuild = match lt_opt {
1319 Some(lt) => region_names.contains(<.name),
1321 let anon = self.cur_anon.get();
1322 let rebuild = anon_nums.contains(&anon);
1324 self.track_anon(anon);
1326 self.inc_and_offset_cur_anon(1);
1333 node: hir::TyRptr(Some(lifetime), mut_ty.clone()),
1336 new_ty = self.rebuild_ty(new_ty, P(to));
1338 ty_queue.push(&*mut_ty.ty);
1340 hir::TyPath(ref maybe_qself, ref path) => {
1341 let a_def = match self.tcx.def_map.borrow().get(&cur_ty.id) {
1347 pprust::path_to_string(path)))
1349 Some(d) => d.full_def()
1352 def::DefTy(did, _) | def::DefStruct(did) => {
1353 let generics = self.tcx.lookup_item_type(did).generics;
1356 generics.regions.len(subst::TypeSpace) as u32;
1358 path.segments.last().unwrap().parameters.lifetimes();
1359 let mut insert = Vec::new();
1360 if lifetimes.is_empty() {
1361 let anon = self.cur_anon.get();
1362 for (i, a) in (anon..anon+expected).enumerate() {
1363 if anon_nums.contains(&a) {
1364 insert.push(i as u32);
1368 self.inc_and_offset_cur_anon(expected);
1370 for (i, lt) in lifetimes.iter().enumerate() {
1371 if region_names.contains(<.name) {
1372 insert.push(i as u32);
1376 let rebuild_info = RebuildPathInfo {
1380 anon_nums: anon_nums,
1381 region_names: region_names
1383 let new_path = self.rebuild_path(rebuild_info, lifetime);
1384 let qself = maybe_qself.as_ref().map(|qself| {
1386 ty: self.rebuild_arg_ty_or_output(&qself.ty, lifetime,
1387 anon_nums, region_names),
1388 position: qself.position
1393 node: hir::TyPath(qself, new_path),
1396 new_ty = self.rebuild_ty(new_ty, P(to));
1403 hir::TyPtr(ref mut_ty) => {
1404 ty_queue.push(&*mut_ty.ty);
1406 hir::TyVec(ref ty) |
1407 hir::TyFixedLengthVec(ref ty, _) => {
1408 ty_queue.push(&**ty);
1410 hir::TyTup(ref tys) => ty_queue.extend(tys.iter().map(|ty| &**ty)),
1417 fn rebuild_ty(&self,
1422 fn build_to(from: P<hir::Ty>,
1423 to: &mut Option<P<hir::Ty>>)
1425 if Some(from.id) == to.as_ref().map(|ty| ty.id) {
1426 return to.take().expect("`to` type found more than once during rebuild");
1428 from.map(|hir::Ty {id, node, span}| {
1429 let new_node = match node {
1430 hir::TyRptr(lifetime, mut_ty) => {
1431 hir::TyRptr(lifetime, hir::MutTy {
1432 mutbl: mut_ty.mutbl,
1433 ty: build_to(mut_ty.ty, to),
1436 hir::TyPtr(mut_ty) => {
1437 hir::TyPtr(hir::MutTy {
1438 mutbl: mut_ty.mutbl,
1439 ty: build_to(mut_ty.ty, to),
1442 hir::TyVec(ty) => hir::TyVec(build_to(ty, to)),
1443 hir::TyFixedLengthVec(ty, e) => {
1444 hir::TyFixedLengthVec(build_to(ty, to), e)
1446 hir::TyTup(tys) => {
1447 hir::TyTup(tys.into_iter().map(|ty| build_to(ty, to)).collect())
1451 hir::Ty { id: id, node: new_node, span: span }
1455 build_to(from, &mut Some(to))
1458 fn rebuild_path(&self,
1459 rebuild_info: RebuildPathInfo,
1460 lifetime: hir::Lifetime)
1463 let RebuildPathInfo {
1471 let last_seg = path.segments.last().unwrap();
1472 let new_parameters = match last_seg.parameters {
1473 hir::ParenthesizedParameters(..) => {
1474 last_seg.parameters.clone()
1477 hir::AngleBracketedParameters(ref data) => {
1478 let mut new_lts = Vec::new();
1479 if data.lifetimes.is_empty() {
1480 // traverse once to see if there's a need to insert lifetime
1481 let need_insert = (0..expected).any(|i| {
1482 indexes.contains(&i)
1485 for i in 0..expected {
1486 if indexes.contains(&i) {
1487 new_lts.push(lifetime);
1489 new_lts.push(self.life_giver.give_lifetime());
1494 for (i, lt) in data.lifetimes.iter().enumerate() {
1495 if indexes.contains(&(i as u32)) {
1496 new_lts.push(lifetime);
1502 let new_types = data.types.map(|t| {
1503 self.rebuild_arg_ty_or_output(&**t, lifetime, anon_nums, region_names)
1505 let new_bindings = data.bindings.map(|b| {
1509 ty: self.rebuild_arg_ty_or_output(&*b.ty,
1516 hir::AngleBracketedParameters(hir::AngleBracketedParameterData {
1519 bindings: new_bindings,
1523 let new_seg = hir::PathSegment {
1524 identifier: last_seg.identifier,
1525 parameters: new_parameters
1527 let mut new_segs = Vec::new();
1528 new_segs.extend_from_slice(path.segments.split_last().unwrap().1);
1529 new_segs.push(new_seg);
1532 global: path.global,
1538 impl<'a, 'tcx> ErrorReportingHelpers<'tcx> for InferCtxt<'a, 'tcx> {
1539 fn give_expl_lifetime_param(&self,
1541 unsafety: hir::Unsafety,
1542 constness: hir::Constness,
1544 opt_explicit_self: Option<&hir::ExplicitSelf_>,
1545 generics: &hir::Generics,
1547 let suggested_fn = pprust::fun_to_string(decl, unsafety, constness, name,
1548 opt_explicit_self, generics);
1549 let msg = format!("consider using an explicit lifetime \
1550 parameter as shown: {}", suggested_fn);
1551 self.tcx.sess.span_help(span, &msg[..]);
1554 fn report_inference_failure(&self,
1555 var_origin: RegionVariableOrigin) {
1556 let br_string = |br: ty::BoundRegion| {
1557 let mut s = br.to_string();
1563 let var_description = match var_origin {
1564 infer::MiscVariable(_) => "".to_string(),
1565 infer::PatternRegion(_) => " for pattern".to_string(),
1566 infer::AddrOfRegion(_) => " for borrow expression".to_string(),
1567 infer::Autoref(_) => " for autoref".to_string(),
1568 infer::Coercion(_) => " for automatic coercion".to_string(),
1569 infer::LateBoundRegion(_, br, infer::FnCall) => {
1570 format!(" for lifetime parameter {}in function call",
1573 infer::LateBoundRegion(_, br, infer::HigherRankedType) => {
1574 format!(" for lifetime parameter {}in generic type", br_string(br))
1576 infer::LateBoundRegion(_, br, infer::AssocTypeProjection(type_name)) => {
1577 format!(" for lifetime parameter {}in trait containing associated type `{}`",
1578 br_string(br), type_name)
1580 infer::EarlyBoundRegion(_, name) => {
1581 format!(" for lifetime parameter `{}`",
1584 infer::BoundRegionInCoherence(name) => {
1585 format!(" for lifetime parameter `{}` in coherence check",
1588 infer::UpvarRegion(ref upvar_id, _) => {
1589 format!(" for capture of `{}` by closure",
1590 self.tcx.local_var_name_str(upvar_id.var_id).to_string())
1594 span_err!(self.tcx.sess, var_origin.span(), E0495,
1595 "cannot infer an appropriate lifetime{} \
1596 due to conflicting requirements",
1600 fn note_region_origin(&self, origin: &SubregionOrigin<'tcx>) {
1602 infer::RFC1214Subregion(ref suborigin) => {
1603 self.note_region_origin(suborigin);
1605 infer::Subtype(ref trace) => {
1606 let desc = match trace.origin {
1607 TypeOrigin::Misc(_) => {
1608 "types are compatible"
1610 TypeOrigin::MethodCompatCheck(_) => {
1611 "method type is compatible with trait"
1613 TypeOrigin::ExprAssignable(_) => {
1614 "expression is assignable"
1616 TypeOrigin::RelateTraitRefs(_) => {
1617 "traits are compatible"
1619 TypeOrigin::RelateSelfType(_) => {
1620 "self type matches impl self type"
1622 TypeOrigin::RelateOutputImplTypes(_) => {
1623 "trait type parameters matches those \
1624 specified on the impl"
1626 TypeOrigin::MatchExpressionArm(_, _, _) => {
1627 "match arms have compatible types"
1629 TypeOrigin::IfExpression(_) => {
1630 "if and else have compatible types"
1632 TypeOrigin::IfExpressionWithNoElse(_) => {
1633 "if may be missing an else clause"
1635 TypeOrigin::RangeExpression(_) => {
1636 "start and end of range have compatible types"
1638 TypeOrigin::EquatePredicate(_) => {
1639 "equality where clause is satisfied"
1643 match self.values_str(&trace.values) {
1644 Some(values_str) => {
1645 self.tcx.sess.span_note(
1646 trace.origin.span(),
1647 &format!("...so that {} ({})",
1651 // Really should avoid printing this error at
1652 // all, since it is derived, but that would
1653 // require more refactoring than I feel like
1654 // doing right now. - nmatsakis
1655 self.tcx.sess.span_note(
1656 trace.origin.span(),
1657 &format!("...so that {}", desc));
1661 infer::Reborrow(span) => {
1662 self.tcx.sess.span_note(
1664 "...so that reference does not outlive \
1667 infer::ReborrowUpvar(span, ref upvar_id) => {
1668 self.tcx.sess.span_note(
1671 "...so that closure can access `{}`",
1672 self.tcx.local_var_name_str(upvar_id.var_id)
1675 infer::InfStackClosure(span) => {
1676 self.tcx.sess.span_note(
1678 "...so that closure does not outlive its stack frame");
1680 infer::InvokeClosure(span) => {
1681 self.tcx.sess.span_note(
1683 "...so that closure is not invoked outside its lifetime");
1685 infer::DerefPointer(span) => {
1686 self.tcx.sess.span_note(
1688 "...so that pointer is not dereferenced \
1689 outside its lifetime");
1691 infer::FreeVariable(span, id) => {
1692 self.tcx.sess.span_note(
1694 &format!("...so that captured variable `{}` \
1695 does not outlive the enclosing closure",
1696 self.tcx.local_var_name_str(id)));
1698 infer::IndexSlice(span) => {
1699 self.tcx.sess.span_note(
1701 "...so that slice is not indexed outside the lifetime");
1703 infer::RelateObjectBound(span) => {
1704 self.tcx.sess.span_note(
1706 "...so that it can be closed over into an object");
1708 infer::CallRcvr(span) => {
1709 self.tcx.sess.span_note(
1711 "...so that method receiver is valid for the method call");
1713 infer::CallArg(span) => {
1714 self.tcx.sess.span_note(
1716 "...so that argument is valid for the call");
1718 infer::CallReturn(span) => {
1719 self.tcx.sess.span_note(
1721 "...so that return value is valid for the call");
1723 infer::Operand(span) => {
1724 self.tcx.sess.span_note(
1726 "...so that operand is valid for operation");
1728 infer::AddrOf(span) => {
1729 self.tcx.sess.span_note(
1731 "...so that reference is valid \
1732 at the time of borrow");
1734 infer::AutoBorrow(span) => {
1735 self.tcx.sess.span_note(
1737 "...so that auto-reference is valid \
1738 at the time of borrow");
1740 infer::ExprTypeIsNotInScope(t, span) => {
1741 self.tcx.sess.span_note(
1743 &format!("...so type `{}` of expression is valid during the \
1745 self.ty_to_string(t)));
1747 infer::BindingTypeIsNotValidAtDecl(span) => {
1748 self.tcx.sess.span_note(
1750 "...so that variable is valid at time of its declaration");
1752 infer::ParameterInScope(_, span) => {
1753 self.tcx.sess.span_note(
1755 "...so that a type/lifetime parameter is in scope here");
1757 infer::DataBorrowed(ty, span) => {
1758 self.tcx.sess.span_note(
1760 &format!("...so that the type `{}` is not borrowed for too long",
1761 self.ty_to_string(ty)));
1763 infer::ReferenceOutlivesReferent(ty, span) => {
1764 self.tcx.sess.span_note(
1766 &format!("...so that the reference type `{}` \
1767 does not outlive the data it points at",
1768 self.ty_to_string(ty)));
1770 infer::RelateParamBound(span, t) => {
1771 self.tcx.sess.span_note(
1773 &format!("...so that the type `{}` \
1774 will meet its required lifetime bounds",
1775 self.ty_to_string(t)));
1777 infer::RelateDefaultParamBound(span, t) => {
1778 self.tcx.sess.span_note(
1780 &format!("...so that type parameter \
1781 instantiated with `{}`, \
1782 will meet its declared lifetime bounds",
1783 self.ty_to_string(t)));
1785 infer::RelateRegionParamBound(span) => {
1786 self.tcx.sess.span_note(
1788 "...so that the declared lifetime parameter bounds \
1791 infer::SafeDestructor(span) => {
1792 self.tcx.sess.span_note(
1794 "...so that references are valid when the destructor \
1801 pub trait Resolvable<'tcx> {
1802 fn resolve<'a>(&self, infcx: &InferCtxt<'a, 'tcx>) -> Self;
1805 impl<'tcx> Resolvable<'tcx> for Ty<'tcx> {
1806 fn resolve<'a>(&self, infcx: &InferCtxt<'a, 'tcx>) -> Ty<'tcx> {
1807 infcx.resolve_type_vars_if_possible(self)
1811 impl<'tcx> Resolvable<'tcx> for ty::TraitRef<'tcx> {
1812 fn resolve<'a>(&self, infcx: &InferCtxt<'a, 'tcx>)
1813 -> ty::TraitRef<'tcx> {
1814 infcx.resolve_type_vars_if_possible(self)
1818 impl<'tcx> Resolvable<'tcx> for ty::PolyTraitRef<'tcx> {
1819 fn resolve<'a>(&self,
1820 infcx: &InferCtxt<'a, 'tcx>)
1821 -> ty::PolyTraitRef<'tcx>
1823 infcx.resolve_type_vars_if_possible(self)
1827 fn lifetimes_in_scope(tcx: &ty::ctxt,
1828 scope_id: ast::NodeId)
1829 -> Vec<hir::LifetimeDef> {
1830 let mut taken = Vec::new();
1831 let parent = tcx.map.get_parent(scope_id);
1832 let method_id_opt = match tcx.map.find(parent) {
1833 Some(node) => match node {
1834 ast_map::NodeItem(item) => match item.node {
1835 hir::ItemFn(_, _, _, _, ref gen, _) => {
1836 taken.extend_from_slice(&gen.lifetimes);
1841 ast_map::NodeImplItem(ii) => {
1843 hir::ImplItemKind::Method(ref sig, _) => {
1844 taken.extend_from_slice(&sig.generics.lifetimes);
1854 if method_id_opt.is_some() {
1855 let method_id = method_id_opt.unwrap();
1856 let parent = tcx.map.get_parent(method_id);
1857 match tcx.map.find(parent) {
1858 Some(node) => match node {
1859 ast_map::NodeItem(item) => match item.node {
1860 hir::ItemImpl(_, _, ref gen, _, _, _) => {
1861 taken.extend_from_slice(&gen.lifetimes);
1873 // LifeGiver is responsible for generating fresh lifetime names
1875 taken: HashSet<String>,
1876 counter: Cell<usize>,
1877 generated: RefCell<Vec<hir::Lifetime>>,
1881 fn with_taken(taken: &[hir::LifetimeDef]) -> LifeGiver {
1882 let mut taken_ = HashSet::new();
1884 let lt_name = lt.lifetime.name.to_string();
1885 taken_.insert(lt_name);
1889 counter: Cell::new(0),
1890 generated: RefCell::new(Vec::new()),
1894 fn inc_counter(&self) {
1895 let c = self.counter.get();
1896 self.counter.set(c+1);
1899 fn give_lifetime(&self) -> hir::Lifetime {
1902 let mut s = String::from("'");
1903 s.push_str(&num_to_string(self.counter.get()));
1904 if !self.taken.contains(&s) {
1905 lifetime = name_to_dummy_lifetime(token::intern(&s[..]));
1906 self.generated.borrow_mut().push(lifetime);
1914 // 0 .. 25 generates a .. z, 26 .. 51 generates aa .. zz, and so on
1915 fn num_to_string(counter: usize) -> String {
1916 let mut s = String::new();
1917 let (n, r) = (counter/26 + 1, counter % 26);
1918 let letter: char = from_u32((r+97) as u32).unwrap();
1926 fn get_generated_lifetimes(&self) -> Vec<hir::Lifetime> {
1927 self.generated.borrow().clone()
1931 fn name_to_dummy_lifetime(name: ast::Name) -> hir::Lifetime {
1932 hir::Lifetime { id: ast::DUMMY_NODE_ID,
1933 span: codemap::DUMMY_SP,