1 //! Trait Resolution. See the [rustc dev guide] for more information on how this works.
3 //! [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/resolution.html
8 pub mod specialization_graph
;
12 use crate::infer
::canonical
::Canonical
;
13 use crate::thir
::abstract_const
::NotConstEvaluatable
;
14 use crate::ty
::subst
::SubstsRef
;
15 use crate::ty
::{self, AdtKind, Ty, TyCtxt}
;
17 use rustc_data_structures
::sync
::Lrc
;
18 use rustc_errors
::{Applicability, Diagnostic}
;
20 use rustc_hir
::def_id
::{DefId, LocalDefId}
;
21 use rustc_span
::symbol
::Symbol
;
22 use rustc_span
::{Span, DUMMY_SP}
;
23 use smallvec
::SmallVec
;
26 use std
::hash
::{Hash, Hasher}
;
28 pub use self::select
::{EvaluationCache, EvaluationResult, OverflowError, SelectionCache}
;
30 pub type CanonicalChalkEnvironmentAndGoal
<'tcx
> = Canonical
<'tcx
, ChalkEnvironmentAndGoal
<'tcx
>>;
32 pub use self::ObligationCauseCode
::*;
34 pub use self::chalk
::{ChalkEnvironmentAndGoal, RustInterner as ChalkRustInterner}
;
36 /// Depending on the stage of compilation, we want projection to be
37 /// more or less conservative.
38 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, HashStable)]
40 /// At type-checking time, we refuse to project any associated
41 /// type that is marked `default`. Non-`default` ("final") types
42 /// are always projected. This is necessary in general for
43 /// soundness of specialization. However, we *could* allow
44 /// projections in fully-monomorphic cases. We choose not to,
45 /// because we prefer for `default type` to force the type
46 /// definition to be treated abstractly by any consumers of the
47 /// impl. Concretely, that means that the following example will
50 /// ```compile_fail,E0308
51 /// #![feature(specialization)]
56 /// impl<T> Assoc for T {
57 /// default type Output = bool;
61 /// let x: <() as Assoc>::Output = true;
65 /// We also do not reveal the hidden type of opaque types during
69 /// At codegen time, all monomorphic projections will succeed.
70 /// Also, `impl Trait` is normalized to the concrete type,
71 /// which has to be already collected by type-checking.
73 /// NOTE: as `impl Trait`'s concrete type should *never*
74 /// be observable directly by the user, `Reveal::All`
75 /// should not be used by checks which may expose
76 /// type equality or type contents to the user.
77 /// There are some exceptions, e.g., around auto traits and
78 /// transmute-checking, which expose some details, but
79 /// not the whole concrete type of the `impl Trait`.
83 /// The reason why we incurred this obligation; used for error reporting.
85 /// Non-misc `ObligationCauseCode`s are stored on the heap. This gives the
86 /// best trade-off between keeping the type small (which makes copies cheaper)
87 /// while not doing too many heap allocations.
89 /// We do not want to intern this as there are a lot of obligation causes which
90 /// only live for a short period of time.
91 #[derive(Clone, Debug, PartialEq, Eq, Lift)]
92 pub struct ObligationCause
<'tcx
> {
95 /// The ID of the fn body that triggered this obligation. This is
96 /// used for region obligations to determine the precise
97 /// environment in which the region obligation should be evaluated
98 /// (in particular, closures can add new assumptions). See the
99 /// field `region_obligations` of the `FulfillmentContext` for more
101 pub body_id
: hir
::HirId
,
103 code
: InternedObligationCauseCode
<'tcx
>,
106 // This custom hash function speeds up hashing for `Obligation` deduplication
107 // greatly by skipping the `code` field, which can be large and complex. That
108 // shouldn't affect hash quality much since there are several other fields in
109 // `Obligation` which should be unique enough, especially the predicate itself
110 // which is hashed as an interned pointer. See #90996.
111 impl Hash
for ObligationCause
<'_
> {
112 fn hash
<H
: Hasher
>(&self, state
: &mut H
) {
113 self.body_id
.hash(state
);
114 self.span
.hash(state
);
118 impl<'tcx
> ObligationCause
<'tcx
> {
123 code
: ObligationCauseCode
<'tcx
>,
124 ) -> ObligationCause
<'tcx
> {
125 ObligationCause { span, body_id, code: code.into() }
128 pub fn misc(span
: Span
, body_id
: hir
::HirId
) -> ObligationCause
<'tcx
> {
129 ObligationCause
::new(span
, body_id
, MiscObligation
)
133 pub fn dummy() -> ObligationCause
<'tcx
> {
134 ObligationCause
::dummy_with_span(DUMMY_SP
)
138 pub fn dummy_with_span(span
: Span
) -> ObligationCause
<'tcx
> {
139 ObligationCause { span, body_id: hir::CRATE_HIR_ID, code: Default::default() }
142 pub fn span(&self, tcx
: TyCtxt
<'tcx
>) -> Span
{
144 ObligationCauseCode
::CompareImplMethodObligation { .. }
145 | ObligationCauseCode
::MainFunctionType
146 | ObligationCauseCode
::StartFunctionType
=> {
147 tcx
.sess
.source_map().guess_head_span(self.span
)
149 ObligationCauseCode
::MatchExpressionArm(box MatchExpressionArmCause
{
158 pub fn code(&self) -> &ObligationCauseCode
<'tcx
> {
164 f
: impl FnOnce(InternedObligationCauseCode
<'tcx
>) -> ObligationCauseCode
<'tcx
>,
166 self.code
= f(std
::mem
::take(&mut self.code
)).into();
169 pub fn derived_cause(
171 parent_trait_pred
: ty
::PolyTraitPredicate
<'tcx
>,
172 variant
: impl FnOnce(DerivedObligationCause
<'tcx
>) -> ObligationCauseCode
<'tcx
>,
173 ) -> ObligationCause
<'tcx
> {
175 * Creates a cause for obligations that are derived from
176 * `obligation` by a recursive search (e.g., for a builtin
177 * bound, or eventually a `auto trait Foo`). If `obligation`
178 * is itself a derived obligation, this is just a clone, but
179 * otherwise we create a "derived obligation" cause so as to
180 * keep track of the original root obligation for error
184 // NOTE(flaper87): As of now, it keeps track of the whole error
185 // chain. Ideally, we should have a way to configure this either
186 // by using -Z verbose or just a CLI argument.
188 variant(DerivedObligationCause { parent_trait_pred, parent_code: self.code }
).into();
193 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
194 pub struct UnifyReceiverContext
<'tcx
> {
195 pub assoc_item
: ty
::AssocItem
,
196 pub param_env
: ty
::ParamEnv
<'tcx
>,
197 pub substs
: SubstsRef
<'tcx
>,
200 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift, Default)]
201 pub struct InternedObligationCauseCode
<'tcx
> {
202 /// `None` for `ObligationCauseCode::MiscObligation` (a common case, occurs ~60% of
203 /// the time). `Some` otherwise.
204 code
: Option
<Lrc
<ObligationCauseCode
<'tcx
>>>,
207 impl<'tcx
> ObligationCauseCode
<'tcx
> {
209 fn into(self) -> InternedObligationCauseCode
<'tcx
> {
210 InternedObligationCauseCode
{
211 code
: if let ObligationCauseCode
::MiscObligation
= self {
220 impl<'tcx
> std
::ops
::Deref
for InternedObligationCauseCode
<'tcx
> {
221 type Target
= ObligationCauseCode
<'tcx
>;
223 fn deref(&self) -> &Self::Target
{
224 self.code
.as_deref().unwrap_or(&ObligationCauseCode
::MiscObligation
)
228 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
229 pub enum ObligationCauseCode
<'tcx
> {
230 /// Not well classified or should be obvious from the span.
233 /// A slice or array is WF only if `T: Sized`.
236 /// A tuple is WF only if its middle elements are `Sized`.
239 /// This is the trait reference from the given projection.
240 ProjectionWf(ty
::ProjectionTy
<'tcx
>),
242 /// In an impl of trait `X` for type `Y`, type `Y` must
243 /// also implement all supertraits of `X`.
244 ItemObligation(DefId
),
246 /// Like `ItemObligation`, but with extra detail on the source of the obligation.
247 BindingObligation(DefId
, Span
),
249 /// A type like `&'a T` is WF only if `T: 'a`.
250 ReferenceOutlivesReferent(Ty
<'tcx
>),
252 /// A type like `Box<Foo<'a> + 'b>` is WF only if `'b: 'a`.
253 ObjectTypeBound(Ty
<'tcx
>, ty
::Region
<'tcx
>),
255 /// Obligation incurred due to an object cast.
256 ObjectCastObligation(/* Object type */ Ty
<'tcx
>),
258 /// Obligation incurred due to a coercion.
264 /// Various cases where expressions must be `Sized` / `Copy` / etc.
265 /// `L = X` implies that `L` is `Sized`.
267 /// `(x1, .., xn)` must be `Sized`.
268 TupleInitializerSized
,
269 /// `S { ... }` must be `Sized`.
270 StructInitializerSized
,
271 /// Type of each variable must be `Sized`.
272 VariableType(hir
::HirId
),
273 /// Argument type must be `Sized`.
274 SizedArgumentType(Option
<Span
>),
275 /// Return type must be `Sized`.
277 /// Yield type must be `Sized`.
279 /// Box expression result type must be `Sized`.
281 /// Inline asm operand type must be `Sized`.
283 /// `[expr; N]` requires `type_of(expr): Copy`.
285 /// If element is a `const fn` we display a help message suggesting to move the
286 /// function call to a new `const` item while saying that `T` doesn't implement `Copy`.
290 /// Types of fields (other than the last, except for packed structs) in a struct must be sized.
297 /// Constant expressions must be sized.
300 /// `static` items must have `Sync` type.
303 BuiltinDerivedObligation(DerivedObligationCause
<'tcx
>),
305 ImplDerivedObligation(Box
<ImplDerivedObligationCause
<'tcx
>>),
307 DerivedObligation(DerivedObligationCause
<'tcx
>),
309 FunctionArgumentObligation
{
310 /// The node of the relevant argument in the function call.
311 arg_hir_id
: hir
::HirId
,
312 /// The node of the function call.
313 call_hir_id
: hir
::HirId
,
314 /// The obligation introduced by this argument.
315 parent_code
: InternedObligationCauseCode
<'tcx
>,
318 /// Error derived when matching traits/impls; see ObligationCause for more details
319 CompareImplConstObligation
,
321 /// Error derived when matching traits/impls; see ObligationCause for more details
322 CompareImplMethodObligation
{
323 impl_item_def_id
: LocalDefId
,
324 trait_item_def_id
: DefId
,
327 /// Error derived when matching traits/impls; see ObligationCause for more details
328 CompareImplTypeObligation
{
329 impl_item_def_id
: LocalDefId
,
330 trait_item_def_id
: DefId
,
333 /// Checking that the bounds of a trait's associated type hold for a given impl
334 CheckAssociatedTypeBounds
{
335 impl_item_def_id
: LocalDefId
,
336 trait_item_def_id
: DefId
,
339 /// Checking that this expression can be assigned to its target.
342 /// Computing common supertype in the arms of a match expression
343 MatchExpressionArm(Box
<MatchExpressionArmCause
<'tcx
>>),
345 /// Type error arising from type checking a pattern against an expected type.
347 /// The span of the scrutinee or type expression which caused the `root_ty` type.
349 /// The root expected type induced by a scrutinee or type expression.
351 /// Whether the `Span` came from an expression or a type expression.
355 /// Constants in patterns must have `Structural` type.
356 ConstPatternStructural
,
358 /// Computing common supertype in an if expression
359 IfExpression(Box
<IfExpressionCause
>),
361 /// Computing common supertype of an if expression with no else counter-part
362 IfExpressionWithNoElse
,
364 /// `main` has wrong type
367 /// `start` has wrong type
370 /// Intrinsic has wrong type
373 /// A let else block does not diverge
379 UnifyReceiver(Box
<UnifyReceiverContext
<'tcx
>>),
381 /// `return` with no expression
384 /// `return` with an expression
385 ReturnValue(hir
::HirId
),
387 /// Return type of this function
390 /// Opaque return type of this function
391 OpaqueReturnType(Option
<(Ty
<'tcx
>, Span
)>),
393 /// Block implicit return
394 BlockTailExpression(hir
::HirId
),
396 /// #[feature(trivial_bounds)] is not enabled
399 /// If `X` is the concrete type of an opaque type `impl Y`, then `X` must implement `Y`
402 AwaitableExpr(Option
<hir
::HirId
>),
408 /// Well-formed checking. If a `WellFormedLoc` is provided,
409 /// then it will be used to eprform HIR-based wf checking
410 /// after an error occurs, in order to generate a more precise error span.
411 /// This is purely for diagnostic purposes - it is always
412 /// correct to use `MiscObligation` instead, or to specify
413 /// `WellFormed(None)`
414 WellFormed(Option
<WellFormedLoc
>),
416 /// From `match_impl`. The cause for us having to match an impl, and the DefId we are matching against.
417 MatchImpl(ObligationCause
<'tcx
>, DefId
),
420 rhs_span
: Option
<Span
>,
425 /// The 'location' at which we try to perform HIR-based wf checking.
426 /// This information is used to obtain an `hir::Ty`, which
427 /// we can walk in order to obtain precise spans for any
428 /// 'nested' types (e.g. `Foo` in `Option<Foo>`).
429 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
430 pub enum WellFormedLoc
{
431 /// Use the type of the provided definition.
433 /// Use the type of the parameter of the provided function.
434 /// We cannot use `hir::Param`, since the function may
435 /// not have a body (e.g. a trait method definition)
437 /// The function to lookup the parameter in
438 function
: LocalDefId
,
439 /// The index of the parameter to use.
440 /// Parameters are indexed from 0, with the return type
441 /// being the last 'parameter'
446 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
447 pub struct ImplDerivedObligationCause
<'tcx
> {
448 pub derived
: DerivedObligationCause
<'tcx
>,
449 pub impl_def_id
: DefId
,
453 impl<'tcx
> ObligationCauseCode
<'tcx
> {
454 // Return the base obligation, ignoring derived obligations.
455 pub fn peel_derives(&self) -> &Self {
456 let mut base_cause
= self;
457 while let Some((parent_code
, _
)) = base_cause
.parent() {
458 base_cause
= parent_code
;
463 pub fn parent(&self) -> Option
<(&Self, Option
<ty
::PolyTraitPredicate
<'tcx
>>)> {
465 FunctionArgumentObligation { parent_code, .. }
=> Some((parent_code
, None
)),
466 BuiltinDerivedObligation(derived
)
467 | DerivedObligation(derived
)
468 | ImplDerivedObligation(box ImplDerivedObligationCause { derived, .. }
) => {
469 Some((&derived
.parent_code
, Some(derived
.parent_trait_pred
)))
476 // `ObligationCauseCode` is used a lot. Make sure it doesn't unintentionally get bigger.
477 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
478 static_assert_size
!(ObligationCauseCode
<'_
>, 48);
480 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
481 pub enum StatementAsExpression
{
486 impl<'tcx
> ty
::Lift
<'tcx
> for StatementAsExpression
{
487 type Lifted
= StatementAsExpression
;
488 fn lift_to_tcx(self, _tcx
: TyCtxt
<'tcx
>) -> Option
<StatementAsExpression
> {
493 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
494 pub struct MatchExpressionArmCause
<'tcx
> {
496 pub scrut_span
: Span
,
497 pub semi_span
: Option
<(Span
, StatementAsExpression
)>,
498 pub source
: hir
::MatchSource
,
499 pub prior_arms
: Vec
<Span
>,
500 pub last_ty
: Ty
<'tcx
>,
501 pub scrut_hir_id
: hir
::HirId
,
502 pub opt_suggest_box_span
: Option
<Span
>,
505 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
506 pub struct IfExpressionCause
{
509 pub outer
: Option
<Span
>,
510 pub semicolon
: Option
<(Span
, StatementAsExpression
)>,
511 pub opt_suggest_box_span
: Option
<Span
>,
514 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
515 pub struct DerivedObligationCause
<'tcx
> {
516 /// The trait predicate of the parent obligation that led to the
517 /// current obligation. Note that only trait obligations lead to
518 /// derived obligations, so we just store the trait predicate here
520 pub parent_trait_pred
: ty
::PolyTraitPredicate
<'tcx
>,
522 /// The parent trait had this cause.
523 pub parent_code
: InternedObligationCauseCode
<'tcx
>,
526 #[derive(Clone, Debug, TypeFoldable, Lift)]
527 pub enum SelectionError
<'tcx
> {
528 /// The trait is not implemented.
530 /// After a closure impl has selected, its "outputs" were evaluated
531 /// (which for closures includes the "input" type params) and they
532 /// didn't resolve. See `confirm_poly_trait_refs` for more.
533 OutputTypeParameterMismatch(
534 ty
::PolyTraitRef
<'tcx
>,
535 ty
::PolyTraitRef
<'tcx
>,
536 ty
::error
::TypeError
<'tcx
>,
538 /// The trait pointed by `DefId` is not object safe.
539 TraitNotObjectSafe(DefId
),
540 /// A given constant couldn't be evaluated.
541 NotConstEvaluatable(NotConstEvaluatable
),
542 /// Exceeded the recursion depth during type projection.
543 Overflow(OverflowError
),
544 /// Signaling that an error has already been emitted, to avoid
545 /// multiple errors being shown.
547 /// Multiple applicable `impl`s where found. The `DefId`s correspond to
548 /// all the `impl`s' Items.
549 Ambiguous(Vec
<DefId
>),
552 /// When performing resolution, it is typically the case that there
553 /// can be one of three outcomes:
555 /// - `Ok(Some(r))`: success occurred with result `r`
556 /// - `Ok(None)`: could not definitely determine anything, usually due
557 /// to inconclusive type inference.
558 /// - `Err(e)`: error `e` occurred
559 pub type SelectionResult
<'tcx
, T
> = Result
<Option
<T
>, SelectionError
<'tcx
>>;
561 /// Given the successful resolution of an obligation, the `ImplSource`
562 /// indicates where the impl comes from.
564 /// For example, the obligation may be satisfied by a specific impl (case A),
565 /// or it may be relative to some bound that is in scope (case B).
567 /// ```ignore (illustrative)
568 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
569 /// impl<T:Clone> Clone<T> for Box<T> { ... } // Impl_2
570 /// impl Clone for i32 { ... } // Impl_3
572 /// fn foo<T: Clone>(concrete: Option<Box<i32>>, param: T, mixed: Option<T>) {
573 /// // Case A: ImplSource points at a specific impl. Only possible when
574 /// // type is concretely known. If the impl itself has bounded
575 /// // type parameters, ImplSource will carry resolutions for those as well:
576 /// concrete.clone(); // ImplSource(Impl_1, [ImplSource(Impl_2, [ImplSource(Impl_3)])])
578 /// // Case A: ImplSource points at a specific impl. Only possible when
579 /// // type is concretely known. If the impl itself has bounded
580 /// // type parameters, ImplSource will carry resolutions for those as well:
581 /// concrete.clone(); // ImplSource(Impl_1, [ImplSource(Impl_2, [ImplSource(Impl_3)])])
583 /// // Case B: ImplSource must be provided by caller. This applies when
584 /// // type is a type parameter.
585 /// param.clone(); // ImplSource::Param
587 /// // Case C: A mix of cases A and B.
588 /// mixed.clone(); // ImplSource(Impl_1, [ImplSource::Param])
592 /// ### The type parameter `N`
594 /// See explanation on `ImplSourceUserDefinedData`.
595 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
596 pub enum ImplSource
<'tcx
, N
> {
597 /// ImplSource identifying a particular impl.
598 UserDefined(ImplSourceUserDefinedData
<'tcx
, N
>),
600 /// ImplSource for auto trait implementations.
601 /// This carries the information and nested obligations with regards
602 /// to an auto implementation for a trait `Trait`. The nested obligations
603 /// ensure the trait implementation holds for all the constituent types.
604 AutoImpl(ImplSourceAutoImplData
<N
>),
606 /// Successful resolution to an obligation provided by the caller
607 /// for some type parameter. The `Vec<N>` represents the
608 /// obligations incurred from normalizing the where-clause (if
610 Param(Vec
<N
>, ty
::BoundConstness
),
612 /// Virtual calls through an object.
613 Object(ImplSourceObjectData
<'tcx
, N
>),
615 /// Successful resolution for a builtin trait.
616 Builtin(ImplSourceBuiltinData
<N
>),
618 /// ImplSource for trait upcasting coercion
619 TraitUpcasting(ImplSourceTraitUpcastingData
<'tcx
, N
>),
621 /// ImplSource automatically generated for a closure. The `DefId` is the ID
622 /// of the closure expression. This is an `ImplSource::UserDefined` in spirit, but the
623 /// impl is generated by the compiler and does not appear in the source.
624 Closure(ImplSourceClosureData
<'tcx
, N
>),
626 /// Same as above, but for a function pointer type with the given signature.
627 FnPointer(ImplSourceFnPointerData
<'tcx
, N
>),
629 /// ImplSource for a builtin `DeterminantKind` trait implementation.
630 DiscriminantKind(ImplSourceDiscriminantKindData
),
632 /// ImplSource for a builtin `Pointee` trait implementation.
633 Pointee(ImplSourcePointeeData
),
635 /// ImplSource automatically generated for a generator.
636 Generator(ImplSourceGeneratorData
<'tcx
, N
>),
638 /// ImplSource for a trait alias.
639 TraitAlias(ImplSourceTraitAliasData
<'tcx
, N
>),
641 /// ImplSource for a `const Drop` implementation.
642 ConstDestruct(ImplSourceConstDestructData
<N
>),
645 impl<'tcx
, N
> ImplSource
<'tcx
, N
> {
646 pub fn nested_obligations(self) -> Vec
<N
> {
648 ImplSource
::UserDefined(i
) => i
.nested
,
649 ImplSource
::Param(n
, _
) => n
,
650 ImplSource
::Builtin(i
) => i
.nested
,
651 ImplSource
::AutoImpl(d
) => d
.nested
,
652 ImplSource
::Closure(c
) => c
.nested
,
653 ImplSource
::Generator(c
) => c
.nested
,
654 ImplSource
::Object(d
) => d
.nested
,
655 ImplSource
::FnPointer(d
) => d
.nested
,
656 ImplSource
::DiscriminantKind(ImplSourceDiscriminantKindData
)
657 | ImplSource
::Pointee(ImplSourcePointeeData
) => Vec
::new(),
658 ImplSource
::TraitAlias(d
) => d
.nested
,
659 ImplSource
::TraitUpcasting(d
) => d
.nested
,
660 ImplSource
::ConstDestruct(i
) => i
.nested
,
664 pub fn borrow_nested_obligations(&self) -> &[N
] {
666 ImplSource
::UserDefined(i
) => &i
.nested
[..],
667 ImplSource
::Param(n
, _
) => &n
,
668 ImplSource
::Builtin(i
) => &i
.nested
,
669 ImplSource
::AutoImpl(d
) => &d
.nested
,
670 ImplSource
::Closure(c
) => &c
.nested
,
671 ImplSource
::Generator(c
) => &c
.nested
,
672 ImplSource
::Object(d
) => &d
.nested
,
673 ImplSource
::FnPointer(d
) => &d
.nested
,
674 ImplSource
::DiscriminantKind(ImplSourceDiscriminantKindData
)
675 | ImplSource
::Pointee(ImplSourcePointeeData
) => &[],
676 ImplSource
::TraitAlias(d
) => &d
.nested
,
677 ImplSource
::TraitUpcasting(d
) => &d
.nested
,
678 ImplSource
::ConstDestruct(i
) => &i
.nested
,
682 pub fn map
<M
, F
>(self, f
: F
) -> ImplSource
<'tcx
, M
>
687 ImplSource
::UserDefined(i
) => ImplSource
::UserDefined(ImplSourceUserDefinedData
{
688 impl_def_id
: i
.impl_def_id
,
690 nested
: i
.nested
.into_iter().map(f
).collect(),
692 ImplSource
::Param(n
, ct
) => ImplSource
::Param(n
.into_iter().map(f
).collect(), ct
),
693 ImplSource
::Builtin(i
) => ImplSource
::Builtin(ImplSourceBuiltinData
{
694 nested
: i
.nested
.into_iter().map(f
).collect(),
696 ImplSource
::Object(o
) => ImplSource
::Object(ImplSourceObjectData
{
697 upcast_trait_ref
: o
.upcast_trait_ref
,
698 vtable_base
: o
.vtable_base
,
699 nested
: o
.nested
.into_iter().map(f
).collect(),
701 ImplSource
::AutoImpl(d
) => ImplSource
::AutoImpl(ImplSourceAutoImplData
{
702 trait_def_id
: d
.trait_def_id
,
703 nested
: d
.nested
.into_iter().map(f
).collect(),
705 ImplSource
::Closure(c
) => ImplSource
::Closure(ImplSourceClosureData
{
706 closure_def_id
: c
.closure_def_id
,
708 nested
: c
.nested
.into_iter().map(f
).collect(),
710 ImplSource
::Generator(c
) => ImplSource
::Generator(ImplSourceGeneratorData
{
711 generator_def_id
: c
.generator_def_id
,
713 nested
: c
.nested
.into_iter().map(f
).collect(),
715 ImplSource
::FnPointer(p
) => ImplSource
::FnPointer(ImplSourceFnPointerData
{
717 nested
: p
.nested
.into_iter().map(f
).collect(),
719 ImplSource
::DiscriminantKind(ImplSourceDiscriminantKindData
) => {
720 ImplSource
::DiscriminantKind(ImplSourceDiscriminantKindData
)
722 ImplSource
::Pointee(ImplSourcePointeeData
) => {
723 ImplSource
::Pointee(ImplSourcePointeeData
)
725 ImplSource
::TraitAlias(d
) => ImplSource
::TraitAlias(ImplSourceTraitAliasData
{
726 alias_def_id
: d
.alias_def_id
,
728 nested
: d
.nested
.into_iter().map(f
).collect(),
730 ImplSource
::TraitUpcasting(d
) => {
731 ImplSource
::TraitUpcasting(ImplSourceTraitUpcastingData
{
732 upcast_trait_ref
: d
.upcast_trait_ref
,
733 vtable_vptr_slot
: d
.vtable_vptr_slot
,
734 nested
: d
.nested
.into_iter().map(f
).collect(),
737 ImplSource
::ConstDestruct(i
) => {
738 ImplSource
::ConstDestruct(ImplSourceConstDestructData
{
739 nested
: i
.nested
.into_iter().map(f
).collect(),
746 /// Identifies a particular impl in the source, along with a set of
747 /// substitutions from the impl's type/lifetime parameters. The
748 /// `nested` vector corresponds to the nested obligations attached to
749 /// the impl's type parameters.
751 /// The type parameter `N` indicates the type used for "nested
752 /// obligations" that are required by the impl. During type-check, this
753 /// is `Obligation`, as one might expect. During codegen, however, this
754 /// is `()`, because codegen only requires a shallow resolution of an
755 /// impl, and nested obligations are satisfied later.
756 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
757 pub struct ImplSourceUserDefinedData
<'tcx
, N
> {
758 pub impl_def_id
: DefId
,
759 pub substs
: SubstsRef
<'tcx
>,
763 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
764 pub struct ImplSourceGeneratorData
<'tcx
, N
> {
765 pub generator_def_id
: DefId
,
766 pub substs
: SubstsRef
<'tcx
>,
767 /// Nested obligations. This can be non-empty if the generator
768 /// signature contains associated types.
772 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
773 pub struct ImplSourceClosureData
<'tcx
, N
> {
774 pub closure_def_id
: DefId
,
775 pub substs
: SubstsRef
<'tcx
>,
776 /// Nested obligations. This can be non-empty if the closure
777 /// signature contains associated types.
781 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
782 pub struct ImplSourceAutoImplData
<N
> {
783 pub trait_def_id
: DefId
,
787 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
788 pub struct ImplSourceTraitUpcastingData
<'tcx
, N
> {
789 /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
790 pub upcast_trait_ref
: ty
::PolyTraitRef
<'tcx
>,
792 /// The vtable is formed by concatenating together the method lists of
793 /// the base object trait and all supertraits, pointers to supertrait vtable will
794 /// be provided when necessary; this is the position of `upcast_trait_ref`'s vtable
795 /// within that vtable.
796 pub vtable_vptr_slot
: Option
<usize>,
801 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
802 pub struct ImplSourceBuiltinData
<N
> {
806 #[derive(PartialEq, Eq, Clone, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
807 pub struct ImplSourceObjectData
<'tcx
, N
> {
808 /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
809 pub upcast_trait_ref
: ty
::PolyTraitRef
<'tcx
>,
811 /// The vtable is formed by concatenating together the method lists of
812 /// the base object trait and all supertraits, pointers to supertrait vtable will
813 /// be provided when necessary; this is the start of `upcast_trait_ref`'s methods
815 pub vtable_base
: usize,
820 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
821 pub struct ImplSourceFnPointerData
<'tcx
, N
> {
826 // FIXME(@lcnr): This should be refactored and merged with other builtin vtables.
827 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
828 pub struct ImplSourceDiscriminantKindData
;
830 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
831 pub struct ImplSourcePointeeData
;
833 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
834 pub struct ImplSourceConstDestructData
<N
> {
838 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
839 pub struct ImplSourceTraitAliasData
<'tcx
, N
> {
840 pub alias_def_id
: DefId
,
841 pub substs
: SubstsRef
<'tcx
>,
845 #[derive(Clone, Debug, PartialEq, Eq, Hash, HashStable, PartialOrd, Ord)]
846 pub enum ObjectSafetyViolation
{
847 /// `Self: Sized` declared on the trait.
848 SizedSelf(SmallVec
<[Span
; 1]>),
850 /// Supertrait reference references `Self` an in illegal location
851 /// (e.g., `trait Foo : Bar<Self>`).
852 SupertraitSelf(SmallVec
<[Span
; 1]>),
854 /// Method has something illegal.
855 Method(Symbol
, MethodViolationCode
, Span
),
857 /// Associated const.
858 AssocConst(Symbol
, Span
),
864 impl ObjectSafetyViolation
{
865 pub fn error_msg(&self) -> Cow
<'
static, str> {
867 ObjectSafetyViolation
::SizedSelf(_
) => "it requires `Self: Sized`".into(),
868 ObjectSafetyViolation
::SupertraitSelf(ref spans
) => {
869 if spans
.iter().any(|sp
| *sp
!= DUMMY_SP
) {
870 "it uses `Self` as a type parameter".into()
872 "it cannot use `Self` as a type parameter in a supertrait or `where`-clause"
876 ObjectSafetyViolation
::Method(name
, MethodViolationCode
::StaticMethod(_
, _
, _
), _
) => {
877 format
!("associated function `{}` has no `self` parameter", name
).into()
879 ObjectSafetyViolation
::Method(
881 MethodViolationCode
::ReferencesSelfInput(_
),
883 ) => format
!("method `{}` references the `Self` type in its parameters", name
).into(),
884 ObjectSafetyViolation
::Method(name
, MethodViolationCode
::ReferencesSelfInput(_
), _
) => {
885 format
!("method `{}` references the `Self` type in this parameter", name
).into()
887 ObjectSafetyViolation
::Method(name
, MethodViolationCode
::ReferencesSelfOutput
, _
) => {
888 format
!("method `{}` references the `Self` type in its return type", name
).into()
890 ObjectSafetyViolation
::Method(
892 MethodViolationCode
::WhereClauseReferencesSelf
,
895 format
!("method `{}` references the `Self` type in its `where` clause", name
).into()
897 ObjectSafetyViolation
::Method(name
, MethodViolationCode
::Generic
, _
) => {
898 format
!("method `{}` has generic type parameters", name
).into()
900 ObjectSafetyViolation
::Method(name
, MethodViolationCode
::UndispatchableReceiver
, _
) => {
901 format
!("method `{}`'s `self` parameter cannot be dispatched on", name
).into()
903 ObjectSafetyViolation
::AssocConst(name
, DUMMY_SP
) => {
904 format
!("it contains associated `const` `{}`", name
).into()
906 ObjectSafetyViolation
::AssocConst(..) => "it contains this associated `const`".into(),
907 ObjectSafetyViolation
::GAT(name
, _
) => {
908 format
!("it contains the generic associated type `{}`", name
).into()
913 pub fn solution(&self, err
: &mut Diagnostic
) {
915 ObjectSafetyViolation
::SizedSelf(_
) | ObjectSafetyViolation
::SupertraitSelf(_
) => {}
916 ObjectSafetyViolation
::Method(
918 MethodViolationCode
::StaticMethod(sugg
, self_span
, has_args
),
924 "consider turning `{}` into a method by giving it a `&self` argument",
927 format
!("&self{}", if has_args { ", " }
else { "" }
),
928 Applicability
::MaybeIncorrect
,
931 Some((sugg
, span
)) => {
935 "alternatively, consider constraining `{}` so it does not apply to \
940 Applicability
::MaybeIncorrect
,
945 "consider turning `{}` into a method by giving it a `&self` \
946 argument or constraining it so it does not apply to trait objects",
952 ObjectSafetyViolation
::Method(
954 MethodViolationCode
::UndispatchableReceiver
,
960 "consider changing method `{}`'s `self` parameter to be `&self`",
964 Applicability
::MachineApplicable
,
967 ObjectSafetyViolation
::AssocConst(name
, _
)
968 | ObjectSafetyViolation
::GAT(name
, _
)
969 | ObjectSafetyViolation
::Method(name
, ..) => {
970 err
.help(&format
!("consider moving `{}` to another trait", name
));
975 pub fn spans(&self) -> SmallVec
<[Span
; 1]> {
976 // When `span` comes from a separate crate, it'll be `DUMMY_SP`. Treat it as `None` so
977 // diagnostics use a `note` instead of a `span_label`.
979 ObjectSafetyViolation
::SupertraitSelf(spans
)
980 | ObjectSafetyViolation
::SizedSelf(spans
) => spans
.clone(),
981 ObjectSafetyViolation
::AssocConst(_
, span
)
982 | ObjectSafetyViolation
::GAT(_
, span
)
983 | ObjectSafetyViolation
::Method(_
, _
, span
)
984 if *span
!= DUMMY_SP
=>
993 /// Reasons a method might not be object-safe.
994 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable, PartialOrd, Ord)]
995 pub enum MethodViolationCode
{
997 StaticMethod(Option
<(&'
static str, Span
)>, Span
, bool
/* has args */),
999 /// e.g., `fn foo(&self, x: Self)`
1000 ReferencesSelfInput(usize),
1002 /// e.g., `fn foo(&self) -> Self`
1003 ReferencesSelfOutput
,
1005 /// e.g., `fn foo(&self) where Self: Clone`
1006 WhereClauseReferencesSelf
,
1008 /// e.g., `fn foo<A>()`
1011 /// the method's receiver (`self` argument) can't be dispatched on
1012 UndispatchableReceiver
,
1015 /// These are the error cases for `codegen_fulfill_obligation`.
1016 #[derive(Copy, Clone, Debug, Hash, HashStable, Encodable, Decodable)]
1017 pub enum CodegenObligationError
{
1018 /// Ambiguity can happen when monomorphizing during trans
1019 /// expands to some humongous type that never occurred
1020 /// statically -- this humongous type can then overflow,
1021 /// leading to an ambiguous result. So report this as an
1022 /// overflow bug, since I believe this is the only case
1023 /// where ambiguity can result.
1025 /// This can trigger when we probe for the source of a `'static` lifetime requirement
1026 /// on a trait object: `impl Foo for dyn Trait {}` has an implicit `'static` bound.
1027 /// This can also trigger when we have a global bound that is not actually satisfied,
1028 /// but was included during typeck due to the trivial_bounds feature.