compiler/rustc_middle/src/traits/mod.rs

   1 //! Trait Resolution. See the [rustc dev guide] for more information on how this works.
   2 //!
   3 //! [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/resolution.html
   4
   5 mod chalk;
   6 pub mod query;
   7 pub mod select;
   8 pub mod specialization_graph;
   9 mod structural_impls;
  10
  11 use crate::infer::canonical::Canonical;
  12 use crate::mir::interpret::ErrorHandled;
  13 use crate::ty::subst::SubstsRef;
  14 use crate::ty::{self, AdtKind, Ty, TyCtxt};
  15
  16 use rustc_errors::{Applicability, DiagnosticBuilder};
  17 use rustc_hir as hir;
  18 use rustc_hir::def_id::DefId;
  19 use rustc_hir::Constness;
  20 use rustc_span::symbol::Symbol;
  21 use rustc_span::{Span, DUMMY_SP};
  22 use smallvec::SmallVec;
  23
  24 use std::borrow::Cow;
  25 use std::fmt;
  26 use std::ops::Deref;
  27 use std::rc::Rc;
  28
  29 pub use self::select::{EvaluationCache, EvaluationResult, OverflowError, SelectionCache};
  30
  31 pub type CanonicalChalkEnvironmentAndGoal<'tcx> = Canonical<'tcx, ChalkEnvironmentAndGoal<'tcx>>;
  32
  33 pub use self::ObligationCauseCode::*;
  34
  35 pub use self::chalk::{ChalkEnvironmentAndGoal, RustInterner as ChalkRustInterner};
  36
  37 /// Depending on the stage of compilation, we want projection to be
  38 /// more or less conservative.
  39 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, HashStable)]
  40 pub enum Reveal {
  41     /// At type-checking time, we refuse to project any associated
  42     /// type that is marked `default`. Non-`default` ("final") types
  43     /// are always projected. This is necessary in general for
  44     /// soundness of specialization. However, we *could* allow
  45     /// projections in fully-monomorphic cases. We choose not to,
  46     /// because we prefer for `default type` to force the type
  47     /// definition to be treated abstractly by any consumers of the
  48     /// impl. Concretely, that means that the following example will
  49     /// fail to compile:
  50     ///
  51     /// ```
  52     /// trait Assoc {
  53     ///     type Output;
  54     /// }
  55     ///
  56     /// impl<T> Assoc for T {
  57     ///     default type Output = bool;
  58     /// }
  59     ///
  60     /// fn main() {
  61     ///     let <() as Assoc>::Output = true;
  62     /// }
  63     /// ```
  64     UserFacing,
  65
  66     /// At codegen time, all monomorphic projections will succeed.
  67     /// Also, `impl Trait` is normalized to the concrete type,
  68     /// which has to be already collected by type-checking.
  69     ///
  70     /// NOTE: as `impl Trait`'s concrete type should *never*
  71     /// be observable directly by the user, `Reveal::All`
  72     /// should not be used by checks which may expose
  73     /// type equality or type contents to the user.
  74     /// There are some exceptions, e.g., around auto traits and
  75     /// transmute-checking, which expose some details, but
  76     /// not the whole concrete type of the `impl Trait`.
  77     All,
  78 }
  79
  80 /// The reason why we incurred this obligation; used for error reporting.
  81 ///
  82 /// As the happy path does not care about this struct, storing this on the heap
  83 /// ends up increasing performance.
  84 ///
  85 /// We do not want to intern this as there are a lot of obligation causes which
  86 /// only live for a short period of time.
  87 #[derive(Clone, PartialEq, Eq, Hash, Lift)]
  88 pub struct ObligationCause<'tcx> {
  89     /// `None` for `ObligationCause::dummy`, `Some` otherwise.
  90     data: Option<Rc<ObligationCauseData<'tcx>>>,
  91 }
  92
  93 const DUMMY_OBLIGATION_CAUSE_DATA: ObligationCauseData<'static> =
  94     ObligationCauseData { span: DUMMY_SP, body_id: hir::CRATE_HIR_ID, code: MiscObligation };
  95
  96 // Correctly format `ObligationCause::dummy`.
  97 impl<'tcx> fmt::Debug for ObligationCause<'tcx> {
  98     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  99         ObligationCauseData::fmt(self, f)
 100     }
 101 }
 102
 103 impl Deref for ObligationCause<'tcx> {
 104     type Target = ObligationCauseData<'tcx>;
 105
 106     #[inline(always)]
 107     fn deref(&self) -> &Self::Target {
 108         self.data.as_deref().unwrap_or(&DUMMY_OBLIGATION_CAUSE_DATA)
 109     }
 110 }
 111
 112 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 113 pub struct ObligationCauseData<'tcx> {
 114     pub span: Span,
 115
 116     /// The ID of the fn body that triggered this obligation. This is
 117     /// used for region obligations to determine the precise
 118     /// environment in which the region obligation should be evaluated
 119     /// (in particular, closures can add new assumptions). See the
 120     /// field `region_obligations` of the `FulfillmentContext` for more
 121     /// information.
 122     pub body_id: hir::HirId,
 123
 124     pub code: ObligationCauseCode<'tcx>,
 125 }
 126
 127 impl<'tcx> ObligationCause<'tcx> {
 128     #[inline]
 129     pub fn new(
 130         span: Span,
 131         body_id: hir::HirId,
 132         code: ObligationCauseCode<'tcx>,
 133     ) -> ObligationCause<'tcx> {
 134         ObligationCause { data: Some(Rc::new(ObligationCauseData { span, body_id, code })) }
 135     }
 136
 137     pub fn misc(span: Span, body_id: hir::HirId) -> ObligationCause<'tcx> {
 138         ObligationCause::new(span, body_id, MiscObligation)
 139     }
 140
 141     pub fn dummy_with_span(span: Span) -> ObligationCause<'tcx> {
 142         ObligationCause::new(span, hir::CRATE_HIR_ID, MiscObligation)
 143     }
 144
 145     #[inline(always)]
 146     pub fn dummy() -> ObligationCause<'tcx> {
 147         ObligationCause { data: None }
 148     }
 149
 150     pub fn make_mut(&mut self) -> &mut ObligationCauseData<'tcx> {
 151         Rc::make_mut(self.data.get_or_insert_with(|| Rc::new(DUMMY_OBLIGATION_CAUSE_DATA)))
 152     }
 153
 154     pub fn span(&self, tcx: TyCtxt<'tcx>) -> Span {
 155         match self.code {
 156             ObligationCauseCode::CompareImplMethodObligation { .. }
 157             | ObligationCauseCode::MainFunctionType
 158             | ObligationCauseCode::StartFunctionType => {
 159                 tcx.sess.source_map().guess_head_span(self.span)
 160             }
 161             ObligationCauseCode::MatchExpressionArm(box MatchExpressionArmCause {
 162                 arm_span,
 163                 ..
 164             }) => arm_span,
 165             _ => self.span,
 166         }
 167     }
 168 }
 169
 170 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 171 pub struct UnifyReceiverContext<'tcx> {
 172     pub assoc_item: ty::AssocItem,
 173     pub param_env: ty::ParamEnv<'tcx>,
 174     pub substs: SubstsRef<'tcx>,
 175 }
 176
 177 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 178 pub enum ObligationCauseCode<'tcx> {
 179     /// Not well classified or should be obvious from the span.
 180     MiscObligation,
 181
 182     /// A slice or array is WF only if `T: Sized`.
 183     SliceOrArrayElem,
 184
 185     /// A tuple is WF only if its middle elements are `Sized`.
 186     TupleElem,
 187
 188     /// This is the trait reference from the given projection.
 189     ProjectionWf(ty::ProjectionTy<'tcx>),
 190
 191     /// In an impl of trait `X` for type `Y`, type `Y` must
 192     /// also implement all supertraits of `X`.
 193     ItemObligation(DefId),
 194
 195     /// Like `ItemObligation`, but with extra detail on the source of the obligation.
 196     BindingObligation(DefId, Span),
 197
 198     /// A type like `&'a T` is WF only if `T: 'a`.
 199     ReferenceOutlivesReferent(Ty<'tcx>),
 200
 201     /// A type like `Box<Foo<'a> + 'b>` is WF only if `'b: 'a`.
 202     ObjectTypeBound(Ty<'tcx>, ty::Region<'tcx>),
 203
 204     /// Obligation incurred due to an object cast.
 205     ObjectCastObligation(/* Object type */ Ty<'tcx>),
 206
 207     /// Obligation incurred due to a coercion.
 208     Coercion {
 209         source: Ty<'tcx>,
 210         target: Ty<'tcx>,
 211     },
 212
 213     /// Various cases where expressions must be `Sized` / `Copy` / etc.
 214     /// `L = X` implies that `L` is `Sized`.
 215     AssignmentLhsSized,
 216     /// `(x1, .., xn)` must be `Sized`.
 217     TupleInitializerSized,
 218     /// `S { ... }` must be `Sized`.
 219     StructInitializerSized,
 220     /// Type of each variable must be `Sized`.
 221     VariableType(hir::HirId),
 222     /// Argument type must be `Sized`.
 223     SizedArgumentType(Option<Span>),
 224     /// Return type must be `Sized`.
 225     SizedReturnType,
 226     /// Yield type must be `Sized`.
 227     SizedYieldType,
 228     /// Inline asm operand type must be `Sized`.
 229     InlineAsmSized,
 230     /// `[T, ..n]` implies that `T` must be `Copy`.
 231     /// If the function in the array repeat expression is a `const fn`,
 232     /// display a help message suggesting to move the function call to a
 233     /// new `const` item while saying that `T` doesn't implement `Copy`.
 234     RepeatVec(bool),
 235
 236     /// Types of fields (other than the last, except for packed structs) in a struct must be sized.
 237     FieldSized {
 238         adt_kind: AdtKind,
 239         span: Span,
 240         last: bool,
 241     },
 242
 243     /// Constant expressions must be sized.
 244     ConstSized,
 245
 246     /// `static` items must have `Sync` type.
 247     SharedStatic,
 248
 249     BuiltinDerivedObligation(DerivedObligationCause<'tcx>),
 250
 251     ImplDerivedObligation(DerivedObligationCause<'tcx>),
 252
 253     DerivedObligation(DerivedObligationCause<'tcx>),
 254
 255     /// Error derived when matching traits/impls; see ObligationCause for more details
 256     CompareImplConstObligation,
 257
 258     /// Error derived when matching traits/impls; see ObligationCause for more details
 259     CompareImplMethodObligation {
 260         item_name: Symbol,
 261         impl_item_def_id: DefId,
 262         trait_item_def_id: DefId,
 263     },
 264
 265     /// Error derived when matching traits/impls; see ObligationCause for more details
 266     CompareImplTypeObligation {
 267         item_name: Symbol,
 268         impl_item_def_id: DefId,
 269         trait_item_def_id: DefId,
 270     },
 271
 272     /// Checking that this expression can be assigned where it needs to be
 273     // FIXME(eddyb) #11161 is the original Expr required?
 274     ExprAssignable,
 275
 276     /// Computing common supertype in the arms of a match expression
 277     MatchExpressionArm(Box<MatchExpressionArmCause<'tcx>>),
 278
 279     /// Type error arising from type checking a pattern against an expected type.
 280     Pattern {
 281         /// The span of the scrutinee or type expression which caused the `root_ty` type.
 282         span: Option<Span>,
 283         /// The root expected type induced by a scrutinee or type expression.
 284         root_ty: Ty<'tcx>,
 285         /// Whether the `Span` came from an expression or a type expression.
 286         origin_expr: bool,
 287     },
 288
 289     /// Constants in patterns must have `Structural` type.
 290     ConstPatternStructural,
 291
 292     /// Computing common supertype in an if expression
 293     IfExpression(Box<IfExpressionCause>),
 294
 295     /// Computing common supertype of an if expression with no else counter-part
 296     IfExpressionWithNoElse,
 297
 298     /// `main` has wrong type
 299     MainFunctionType,
 300
 301     /// `start` has wrong type
 302     StartFunctionType,
 303
 304     /// Intrinsic has wrong type
 305     IntrinsicType,
 306
 307     /// Method receiver
 308     MethodReceiver,
 309
 310     UnifyReceiver(Box<UnifyReceiverContext<'tcx>>),
 311
 312     /// `return` with no expression
 313     ReturnNoExpression,
 314
 315     /// `return` with an expression
 316     ReturnValue(hir::HirId),
 317
 318     /// Return type of this function
 319     ReturnType,
 320
 321     /// Block implicit return
 322     BlockTailExpression(hir::HirId),
 323
 324     /// #[feature(trivial_bounds)] is not enabled
 325     TrivialBound,
 326 }
 327
 328 impl ObligationCauseCode<'_> {
 329     // Return the base obligation, ignoring derived obligations.
 330     pub fn peel_derives(&self) -> &Self {
 331         let mut base_cause = self;
 332         while let BuiltinDerivedObligation(cause)
 333         | ImplDerivedObligation(cause)
 334         | DerivedObligation(cause) = base_cause
 335         {
 336             base_cause = &cause.parent_code;
 337         }
 338         base_cause
 339     }
 340 }
 341
 342 // `ObligationCauseCode` is used a lot. Make sure it doesn't unintentionally get bigger.
 343 #[cfg(target_arch = "x86_64")]
 344 static_assert_size!(ObligationCauseCode<'_>, 32);
 345
 346 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
 347 pub enum StatementAsExpression {
 348     CorrectType,
 349     NeedsBoxing,
 350 }
 351
 352 impl<'tcx> ty::Lift<'tcx> for StatementAsExpression {
 353     type Lifted = StatementAsExpression;
 354     fn lift_to_tcx(self, _tcx: TyCtxt<'tcx>) -> Option<StatementAsExpression> {
 355         Some(self)
 356     }
 357 }
 358
 359 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 360 pub struct MatchExpressionArmCause<'tcx> {
 361     pub arm_span: Span,
 362     pub scrut_span: Span,
 363     pub semi_span: Option<(Span, StatementAsExpression)>,
 364     pub source: hir::MatchSource,
 365     pub prior_arms: Vec<Span>,
 366     pub last_ty: Ty<'tcx>,
 367     pub scrut_hir_id: hir::HirId,
 368     pub opt_suggest_box_span: Option<Span>,
 369 }
 370
 371 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
 372 pub struct IfExpressionCause {
 373     pub then: Span,
 374     pub else_sp: Span,
 375     pub outer: Option<Span>,
 376     pub semicolon: Option<(Span, StatementAsExpression)>,
 377     pub opt_suggest_box_span: Option<Span>,
 378 }
 379
 380 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
 381 pub struct DerivedObligationCause<'tcx> {
 382     /// The trait reference of the parent obligation that led to the
 383     /// current obligation. Note that only trait obligations lead to
 384     /// derived obligations, so we just store the trait reference here
 385     /// directly.
 386     pub parent_trait_ref: ty::PolyTraitRef<'tcx>,
 387
 388     /// The parent trait had this cause.
 389     pub parent_code: Rc<ObligationCauseCode<'tcx>>,
 390 }
 391
 392 #[derive(Clone, Debug, TypeFoldable, Lift)]
 393 pub enum SelectionError<'tcx> {
 394     Unimplemented,
 395     OutputTypeParameterMismatch(
 396         ty::PolyTraitRef<'tcx>,
 397         ty::PolyTraitRef<'tcx>,
 398         ty::error::TypeError<'tcx>,
 399     ),
 400     TraitNotObjectSafe(DefId),
 401     ConstEvalFailure(ErrorHandled),
 402     Overflow,
 403 }
 404
 405 /// When performing resolution, it is typically the case that there
 406 /// can be one of three outcomes:
 407 ///
 408 /// - `Ok(Some(r))`: success occurred with result `r`
 409 /// - `Ok(None)`: could not definitely determine anything, usually due
 410 ///   to inconclusive type inference.
 411 /// - `Err(e)`: error `e` occurred
 412 pub type SelectionResult<'tcx, T> = Result<Option<T>, SelectionError<'tcx>>;
 413
 414 /// Given the successful resolution of an obligation, the `ImplSource`
 415 /// indicates where the impl comes from.
 416 ///
 417 /// For example, the obligation may be satisfied by a specific impl (case A),
 418 /// or it may be relative to some bound that is in scope (case B).
 419 ///
 420 /// ```
 421 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
 422 /// impl<T:Clone> Clone<T> for Box<T> { ... }    // Impl_2
 423 /// impl Clone for i32 { ... }                   // Impl_3
 424 ///
 425 /// fn foo<T: Clone>(concrete: Option<Box<i32>>, param: T, mixed: Option<T>) {
 426 ///     // Case A: Vtable points at a specific impl. Only possible when
 427 ///     // type is concretely known. If the impl itself has bounded
 428 ///     // type parameters, Vtable will carry resolutions for those as well:
 429 ///     concrete.clone(); // Vtable(Impl_1, [Vtable(Impl_2, [Vtable(Impl_3)])])
 430 ///
 431 ///     // Case A: ImplSource points at a specific impl. Only possible when
 432 ///     // type is concretely known. If the impl itself has bounded
 433 ///     // type parameters, ImplSource will carry resolutions for those as well:
 434 ///     concrete.clone(); // ImplSource(Impl_1, [ImplSource(Impl_2, [ImplSource(Impl_3)])])
 435 ///
 436 ///     // Case B: ImplSource must be provided by caller. This applies when
 437 ///     // type is a type parameter.
 438 ///     param.clone();    // ImplSource::Param
 439 ///
 440 ///     // Case C: A mix of cases A and B.
 441 ///     mixed.clone();    // ImplSource(Impl_1, [ImplSource::Param])
 442 /// }
 443 /// ```
 444 ///
 445 /// ### The type parameter `N`
 446 ///
 447 /// See explanation on `ImplSourceUserDefinedData`.
 448 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 449 pub enum ImplSource<'tcx, N> {
 450     /// ImplSource identifying a particular impl.
 451     UserDefined(ImplSourceUserDefinedData<'tcx, N>),
 452
 453     /// ImplSource for auto trait implementations.
 454     /// This carries the information and nested obligations with regards
 455     /// to an auto implementation for a trait `Trait`. The nested obligations
 456     /// ensure the trait implementation holds for all the constituent types.
 457     AutoImpl(ImplSourceAutoImplData<N>),
 458
 459     /// Successful resolution to an obligation provided by the caller
 460     /// for some type parameter. The `Vec<N>` represents the
 461     /// obligations incurred from normalizing the where-clause (if
 462     /// any).
 463     Param(Vec<N>, Constness),
 464
 465     /// Virtual calls through an object.
 466     Object(ImplSourceObjectData<'tcx, N>),
 467
 468     /// Successful resolution for a builtin trait.
 469     Builtin(ImplSourceBuiltinData<N>),
 470
 471     /// ImplSource automatically generated for a closure. The `DefId` is the ID
 472     /// of the closure expression. This is a `ImplSource::UserDefined` in spirit, but the
 473     /// impl is generated by the compiler and does not appear in the source.
 474     Closure(ImplSourceClosureData<'tcx, N>),
 475
 476     /// Same as above, but for a function pointer type with the given signature.
 477     FnPointer(ImplSourceFnPointerData<'tcx, N>),
 478
 479     /// ImplSource for a builtin `DeterminantKind` trait implementation.
 480     DiscriminantKind(ImplSourceDiscriminantKindData),
 481
 482     /// ImplSource automatically generated for a generator.
 483     Generator(ImplSourceGeneratorData<'tcx, N>),
 484
 485     /// ImplSource for a trait alias.
 486     TraitAlias(ImplSourceTraitAliasData<'tcx, N>),
 487 }
 488
 489 impl<'tcx, N> ImplSource<'tcx, N> {
 490     pub fn nested_obligations(self) -> Vec<N> {
 491         match self {
 492             ImplSource::UserDefined(i) => i.nested,
 493             ImplSource::Param(n, _) => n,
 494             ImplSource::Builtin(i) => i.nested,
 495             ImplSource::AutoImpl(d) => d.nested,
 496             ImplSource::Closure(c) => c.nested,
 497             ImplSource::Generator(c) => c.nested,
 498             ImplSource::Object(d) => d.nested,
 499             ImplSource::FnPointer(d) => d.nested,
 500             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => Vec::new(),
 501             ImplSource::TraitAlias(d) => d.nested,
 502         }
 503     }
 504
 505     pub fn borrow_nested_obligations(&self) -> &[N] {
 506         match &self {
 507             ImplSource::UserDefined(i) => &i.nested[..],
 508             ImplSource::Param(n, _) => &n[..],
 509             ImplSource::Builtin(i) => &i.nested[..],
 510             ImplSource::AutoImpl(d) => &d.nested[..],
 511             ImplSource::Closure(c) => &c.nested[..],
 512             ImplSource::Generator(c) => &c.nested[..],
 513             ImplSource::Object(d) => &d.nested[..],
 514             ImplSource::FnPointer(d) => &d.nested[..],
 515             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => &[],
 516             ImplSource::TraitAlias(d) => &d.nested[..],
 517         }
 518     }
 519
 520     pub fn map<M, F>(self, f: F) -> ImplSource<'tcx, M>
 521     where
 522         F: FnMut(N) -> M,
 523     {
 524         match self {
 525             ImplSource::UserDefined(i) => ImplSource::UserDefined(ImplSourceUserDefinedData {
 526                 impl_def_id: i.impl_def_id,
 527                 substs: i.substs,
 528                 nested: i.nested.into_iter().map(f).collect(),
 529             }),
 530             ImplSource::Param(n, ct) => ImplSource::Param(n.into_iter().map(f).collect(), ct),
 531             ImplSource::Builtin(i) => ImplSource::Builtin(ImplSourceBuiltinData {
 532                 nested: i.nested.into_iter().map(f).collect(),
 533             }),
 534             ImplSource::Object(o) => ImplSource::Object(ImplSourceObjectData {
 535                 upcast_trait_ref: o.upcast_trait_ref,
 536                 vtable_base: o.vtable_base,
 537                 nested: o.nested.into_iter().map(f).collect(),
 538             }),
 539             ImplSource::AutoImpl(d) => ImplSource::AutoImpl(ImplSourceAutoImplData {
 540                 trait_def_id: d.trait_def_id,
 541                 nested: d.nested.into_iter().map(f).collect(),
 542             }),
 543             ImplSource::Closure(c) => ImplSource::Closure(ImplSourceClosureData {
 544                 closure_def_id: c.closure_def_id,
 545                 substs: c.substs,
 546                 nested: c.nested.into_iter().map(f).collect(),
 547             }),
 548             ImplSource::Generator(c) => ImplSource::Generator(ImplSourceGeneratorData {
 549                 generator_def_id: c.generator_def_id,
 550                 substs: c.substs,
 551                 nested: c.nested.into_iter().map(f).collect(),
 552             }),
 553             ImplSource::FnPointer(p) => ImplSource::FnPointer(ImplSourceFnPointerData {
 554                 fn_ty: p.fn_ty,
 555                 nested: p.nested.into_iter().map(f).collect(),
 556             }),
 557             ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => {
 558                 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData)
 559             }
 560             ImplSource::TraitAlias(d) => ImplSource::TraitAlias(ImplSourceTraitAliasData {
 561                 alias_def_id: d.alias_def_id,
 562                 substs: d.substs,
 563                 nested: d.nested.into_iter().map(f).collect(),
 564             }),
 565         }
 566     }
 567 }
 568
 569 /// Identifies a particular impl in the source, along with a set of
 570 /// substitutions from the impl's type/lifetime parameters. The
 571 /// `nested` vector corresponds to the nested obligations attached to
 572 /// the impl's type parameters.
 573 ///
 574 /// The type parameter `N` indicates the type used for "nested
 575 /// obligations" that are required by the impl. During type-check, this
 576 /// is `Obligation`, as one might expect. During codegen, however, this
 577 /// is `()`, because codegen only requires a shallow resolution of an
 578 /// impl, and nested obligations are satisfied later.
 579 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 580 pub struct ImplSourceUserDefinedData<'tcx, N> {
 581     pub impl_def_id: DefId,
 582     pub substs: SubstsRef<'tcx>,
 583     pub nested: Vec<N>,
 584 }
 585
 586 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 587 pub struct ImplSourceGeneratorData<'tcx, N> {
 588     pub generator_def_id: DefId,
 589     pub substs: SubstsRef<'tcx>,
 590     /// Nested obligations. This can be non-empty if the generator
 591     /// signature contains associated types.
 592     pub nested: Vec<N>,
 593 }
 594
 595 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 596 pub struct ImplSourceClosureData<'tcx, N> {
 597     pub closure_def_id: DefId,
 598     pub substs: SubstsRef<'tcx>,
 599     /// Nested obligations. This can be non-empty if the closure
 600     /// signature contains associated types.
 601     pub nested: Vec<N>,
 602 }
 603
 604 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 605 pub struct ImplSourceAutoImplData<N> {
 606     pub trait_def_id: DefId,
 607     pub nested: Vec<N>,
 608 }
 609
 610 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 611 pub struct ImplSourceBuiltinData<N> {
 612     pub nested: Vec<N>,
 613 }
 614
 615 #[derive(PartialEq, Eq, Clone, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 616 pub struct ImplSourceObjectData<'tcx, N> {
 617     /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
 618     pub upcast_trait_ref: ty::PolyTraitRef<'tcx>,
 619
 620     /// The vtable is formed by concatenating together the method lists of
 621     /// the base object trait and all supertraits; this is the start of
 622     /// `upcast_trait_ref`'s methods in that vtable.
 623     pub vtable_base: usize,
 624
 625     pub nested: Vec<N>,
 626 }
 627
 628 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 629 pub struct ImplSourceFnPointerData<'tcx, N> {
 630     pub fn_ty: Ty<'tcx>,
 631     pub nested: Vec<N>,
 632 }
 633
 634 // FIXME(@lcnr): This should be  refactored and merged with other builtin vtables.
 635 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
 636 pub struct ImplSourceDiscriminantKindData;
 637
 638 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
 639 pub struct ImplSourceTraitAliasData<'tcx, N> {
 640     pub alias_def_id: DefId,
 641     pub substs: SubstsRef<'tcx>,
 642     pub nested: Vec<N>,
 643 }
 644
 645 #[derive(Clone, Debug, PartialEq, Eq, Hash, HashStable)]
 646 pub enum ObjectSafetyViolation {
 647     /// `Self: Sized` declared on the trait.
 648     SizedSelf(SmallVec<[Span; 1]>),
 649
 650     /// Supertrait reference references `Self` an in illegal location
 651     /// (e.g., `trait Foo : Bar<Self>`).
 652     SupertraitSelf(SmallVec<[Span; 1]>),
 653
 654     /// Method has something illegal.
 655     Method(Symbol, MethodViolationCode, Span),
 656
 657     /// Associated const.
 658     AssocConst(Symbol, Span),
 659 }
 660
 661 impl ObjectSafetyViolation {
 662     pub fn error_msg(&self) -> Cow<'static, str> {
 663         match *self {
 664             ObjectSafetyViolation::SizedSelf(_) => "it requires `Self: Sized`".into(),
 665             ObjectSafetyViolation::SupertraitSelf(ref spans) => {
 666                 if spans.iter().any(|sp| *sp != DUMMY_SP) {
 667                     "it uses `Self` as a type parameter".into()
 668                 } else {
 669                     "it cannot use `Self` as a type parameter in a supertrait or `where`-clause"
 670                         .into()
 671                 }
 672             }
 673             ObjectSafetyViolation::Method(name, MethodViolationCode::StaticMethod(_, _, _), _) => {
 674                 format!("associated function `{}` has no `self` parameter", name).into()
 675             }
 676             ObjectSafetyViolation::Method(
 677                 name,
 678                 MethodViolationCode::ReferencesSelfInput(_),
 679                 DUMMY_SP,
 680             ) => format!("method `{}` references the `Self` type in its parameters", name).into(),
 681             ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfInput(_), _) => {
 682                 format!("method `{}` references the `Self` type in this parameter", name).into()
 683             }
 684             ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfOutput, _) => {
 685                 format!("method `{}` references the `Self` type in its return type", name).into()
 686             }
 687             ObjectSafetyViolation::Method(
 688                 name,
 689                 MethodViolationCode::WhereClauseReferencesSelf,
 690                 _,
 691             ) => {
 692                 format!("method `{}` references the `Self` type in its `where` clause", name).into()
 693             }
 694             ObjectSafetyViolation::Method(name, MethodViolationCode::Generic, _) => {
 695                 format!("method `{}` has generic type parameters", name).into()
 696             }
 697             ObjectSafetyViolation::Method(name, MethodViolationCode::UndispatchableReceiver, _) => {
 698                 format!("method `{}`'s `self` parameter cannot be dispatched on", name).into()
 699             }
 700             ObjectSafetyViolation::AssocConst(name, DUMMY_SP) => {
 701                 format!("it contains associated `const` `{}`", name).into()
 702             }
 703             ObjectSafetyViolation::AssocConst(..) => "it contains this associated `const`".into(),
 704         }
 705     }
 706
 707     pub fn solution(&self, err: &mut DiagnosticBuilder<'_>) {
 708         match *self {
 709             ObjectSafetyViolation::SizedSelf(_) | ObjectSafetyViolation::SupertraitSelf(_) => {}
 710             ObjectSafetyViolation::Method(
 711                 name,
 712                 MethodViolationCode::StaticMethod(sugg, self_span, has_args),
 713                 _,
 714             ) => {
 715                 err.span_suggestion(
 716                     self_span,
 717                     &format!(
 718                         "consider turning `{}` into a method by giving it a `&self` argument",
 719                         name
 720                     ),
 721                     format!("&self{}", if has_args { ", " } else { "" }),
 722                     Applicability::MaybeIncorrect,
 723                 );
 724                 match sugg {
 725                     Some((sugg, span)) => {
 726                         err.span_suggestion(
 727                             span,
 728                             &format!(
 729                                 "alternatively, consider constraining `{}` so it does not apply to \
 730                                  trait objects",
 731                                 name
 732                             ),
 733                             sugg.to_string(),
 734                             Applicability::MaybeIncorrect,
 735                         );
 736                     }
 737                     None => {
 738                         err.help(&format!(
 739                             "consider turning `{}` into a method by giving it a `&self` \
 740                              argument or constraining it so it does not apply to trait objects",
 741                             name
 742                         ));
 743                     }
 744                 }
 745             }
 746             ObjectSafetyViolation::Method(
 747                 name,
 748                 MethodViolationCode::UndispatchableReceiver,
 749                 span,
 750             ) => {
 751                 err.span_suggestion(
 752                     span,
 753                     &format!(
 754                         "consider changing method `{}`'s `self` parameter to be `&self`",
 755                         name
 756                     ),
 757                     "&Self".to_string(),
 758                     Applicability::MachineApplicable,
 759                 );
 760             }
 761             ObjectSafetyViolation::AssocConst(name, _)
 762             | ObjectSafetyViolation::Method(name, ..) => {
 763                 err.help(&format!("consider moving `{}` to another trait", name));
 764             }
 765         }
 766     }
 767
 768     pub fn spans(&self) -> SmallVec<[Span; 1]> {
 769         // When `span` comes from a separate crate, it'll be `DUMMY_SP`. Treat it as `None` so
 770         // diagnostics use a `note` instead of a `span_label`.
 771         match self {
 772             ObjectSafetyViolation::SupertraitSelf(spans)
 773             | ObjectSafetyViolation::SizedSelf(spans) => spans.clone(),
 774             ObjectSafetyViolation::AssocConst(_, span)
 775             | ObjectSafetyViolation::Method(_, _, span)
 776                 if *span != DUMMY_SP =>
 777             {
 778                 smallvec![*span]
 779             }
 780             _ => smallvec![],
 781         }
 782     }
 783 }
 784
 785 /// Reasons a method might not be object-safe.
 786 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
 787 pub enum MethodViolationCode {
 788     /// e.g., `fn foo()`
 789     StaticMethod(Option<(&'static str, Span)>, Span, bool /* has args */),
 790
 791     /// e.g., `fn foo(&self, x: Self)`
 792     ReferencesSelfInput(usize),
 793
 794     /// e.g., `fn foo(&self) -> Self`
 795     ReferencesSelfOutput,
 796
 797     /// e.g., `fn foo(&self) where Self: Clone`
 798     WhereClauseReferencesSelf,
 799
 800     /// e.g., `fn foo<A>()`
 801     Generic,
 802
 803     /// the method's receiver (`self` argument) can't be dispatched on
 804     UndispatchableReceiver,
 805 }