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;
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};
16 use rustc_errors::{Applicability, DiagnosticBuilder};
18 use rustc_hir::def_id::DefId;
19 use rustc_span::symbol::Symbol;
20 use rustc_span::{Span, DUMMY_SP};
21 use smallvec::SmallVec;
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
55 /// impl<T> Assoc for T {
56 /// default type Output = bool;
60 /// let <() as Assoc>::Output = true;
65 /// At codegen time, all monomorphic projections will succeed.
66 /// Also, `impl Trait` is normalized to the concrete type,
67 /// which has to be already collected by type-checking.
69 /// NOTE: as `impl Trait`'s concrete type should *never*
70 /// be observable directly by the user, `Reveal::All`
71 /// should not be used by checks which may expose
72 /// type equality or type contents to the user.
73 /// There are some exceptions, e.g., around OIBITS and
74 /// transmute-checking, which expose some details, but
75 /// not the whole concrete type of the `impl Trait`.
79 /// The reason why we incurred this obligation; used for error reporting.
81 /// As the happy path does not care about this struct, storing this on the heap
82 /// ends up increasing performance.
84 /// We do not want to intern this as there are a lot of obligation causes which
85 /// only live for a short period of time.
86 #[derive(Clone, PartialEq, Eq, Hash, Lift)]
87 pub struct ObligationCause<'tcx> {
88 /// `None` for `ObligationCause::dummy`, `Some` otherwise.
89 data: Option<Rc<ObligationCauseData<'tcx>>>,
92 const DUMMY_OBLIGATION_CAUSE_DATA: ObligationCauseData<'static> =
93 ObligationCauseData { span: DUMMY_SP, body_id: hir::CRATE_HIR_ID, code: MiscObligation };
95 // Correctly format `ObligationCause::dummy`.
96 impl<'tcx> fmt::Debug for ObligationCause<'tcx> {
97 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
98 ObligationCauseData::fmt(self, f)
102 impl Deref for ObligationCause<'tcx> {
103 type Target = ObligationCauseData<'tcx>;
106 fn deref(&self) -> &Self::Target {
107 self.data.as_deref().unwrap_or(&DUMMY_OBLIGATION_CAUSE_DATA)
111 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
112 pub struct ObligationCauseData<'tcx> {
115 /// The ID of the fn body that triggered this obligation. This is
116 /// used for region obligations to determine the precise
117 /// environment in which the region obligation should be evaluated
118 /// (in particular, closures can add new assumptions). See the
119 /// field `region_obligations` of the `FulfillmentContext` for more
121 pub body_id: hir::HirId,
123 pub code: ObligationCauseCode<'tcx>,
126 impl<'tcx> ObligationCause<'tcx> {
131 code: ObligationCauseCode<'tcx>,
132 ) -> ObligationCause<'tcx> {
133 ObligationCause { data: Some(Rc::new(ObligationCauseData { span, body_id, code })) }
136 pub fn misc(span: Span, body_id: hir::HirId) -> ObligationCause<'tcx> {
137 ObligationCause::new(span, body_id, MiscObligation)
140 pub fn dummy_with_span(span: Span) -> ObligationCause<'tcx> {
141 ObligationCause::new(span, hir::CRATE_HIR_ID, MiscObligation)
145 pub fn dummy() -> ObligationCause<'tcx> {
146 ObligationCause { data: None }
149 pub fn make_mut(&mut self) -> &mut ObligationCauseData<'tcx> {
150 Rc::make_mut(self.data.get_or_insert_with(|| Rc::new(DUMMY_OBLIGATION_CAUSE_DATA)))
153 pub fn span(&self, tcx: TyCtxt<'tcx>) -> Span {
155 ObligationCauseCode::CompareImplMethodObligation { .. }
156 | ObligationCauseCode::MainFunctionType
157 | ObligationCauseCode::StartFunctionType => {
158 tcx.sess.source_map().guess_head_span(self.span)
160 ObligationCauseCode::MatchExpressionArm(box MatchExpressionArmCause {
169 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
170 pub struct UnifyReceiverContext<'tcx> {
171 pub assoc_item: ty::AssocItem,
172 pub param_env: ty::ParamEnv<'tcx>,
173 pub substs: SubstsRef<'tcx>,
176 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
177 pub enum ObligationCauseCode<'tcx> {
178 /// Not well classified or should be obvious from the span.
181 /// A slice or array is WF only if `T: Sized`.
184 /// A tuple is WF only if its middle elements are `Sized`.
187 /// This is the trait reference from the given projection.
188 ProjectionWf(ty::ProjectionTy<'tcx>),
190 /// In an impl of trait `X` for type `Y`, type `Y` must
191 /// also implement all supertraits of `X`.
192 ItemObligation(DefId),
194 /// Like `ItemObligation`, but with extra detail on the source of the obligation.
195 BindingObligation(DefId, Span),
197 /// A type like `&'a T` is WF only if `T: 'a`.
198 ReferenceOutlivesReferent(Ty<'tcx>),
200 /// A type like `Box<Foo<'a> + 'b>` is WF only if `'b: 'a`.
201 ObjectTypeBound(Ty<'tcx>, ty::Region<'tcx>),
203 /// Obligation incurred due to an object cast.
204 ObjectCastObligation(/* Object type */ Ty<'tcx>),
206 /// Obligation incurred due to a coercion.
212 /// Various cases where expressions must be `Sized` / `Copy` / etc.
213 /// `L = X` implies that `L` is `Sized`.
215 /// `(x1, .., xn)` must be `Sized`.
216 TupleInitializerSized,
217 /// `S { ... }` must be `Sized`.
218 StructInitializerSized,
219 /// Type of each variable must be `Sized`.
220 VariableType(hir::HirId),
221 /// Argument type must be `Sized`.
222 SizedArgumentType(Option<Span>),
223 /// Return type must be `Sized`.
225 /// Yield type must be `Sized`.
227 /// Inline asm operand type must be `Sized`.
229 /// `[T, ..n]` implies that `T` must be `Copy`.
230 /// If `true`, suggest `const_in_array_repeat_expressions` feature flag.
233 /// Types of fields (other than the last, except for packed structs) in a struct must be sized.
240 /// Constant expressions must be sized.
243 /// `static` items must have `Sync` type.
246 BuiltinDerivedObligation(DerivedObligationCause<'tcx>),
248 ImplDerivedObligation(DerivedObligationCause<'tcx>),
250 DerivedObligation(DerivedObligationCause<'tcx>),
252 /// Error derived when matching traits/impls; see ObligationCause for more details
253 CompareImplConstObligation,
255 /// Error derived when matching traits/impls; see ObligationCause for more details
256 CompareImplMethodObligation {
258 impl_item_def_id: DefId,
259 trait_item_def_id: DefId,
262 /// Error derived when matching traits/impls; see ObligationCause for more details
263 CompareImplTypeObligation {
265 impl_item_def_id: DefId,
266 trait_item_def_id: DefId,
269 /// Checking that this expression can be assigned where it needs to be
270 // FIXME(eddyb) #11161 is the original Expr required?
273 /// Computing common supertype in the arms of a match expression
274 MatchExpressionArm(Box<MatchExpressionArmCause<'tcx>>),
276 /// Type error arising from type checking a pattern against an expected type.
278 /// The span of the scrutinee or type expression which caused the `root_ty` type.
280 /// The root expected type induced by a scrutinee or type expression.
282 /// Whether the `Span` came from an expression or a type expression.
286 /// Constants in patterns must have `Structural` type.
287 ConstPatternStructural,
289 /// Computing common supertype in an if expression
290 IfExpression(Box<IfExpressionCause>),
292 /// Computing common supertype of an if expression with no else counter-part
293 IfExpressionWithNoElse,
295 /// `main` has wrong type
298 /// `start` has wrong type
301 /// Intrinsic has wrong type
307 UnifyReceiver(Box<UnifyReceiverContext<'tcx>>),
309 /// `return` with no expression
312 /// `return` with an expression
313 ReturnValue(hir::HirId),
315 /// Return type of this function
318 /// Block implicit return
319 BlockTailExpression(hir::HirId),
321 /// #[feature(trivial_bounds)] is not enabled
325 impl ObligationCauseCode<'_> {
326 // Return the base obligation, ignoring derived obligations.
327 pub fn peel_derives(&self) -> &Self {
328 let mut base_cause = self;
329 while let BuiltinDerivedObligation(cause)
330 | ImplDerivedObligation(cause)
331 | DerivedObligation(cause) = base_cause
333 base_cause = &cause.parent_code;
339 // `ObligationCauseCode` is used a lot. Make sure it doesn't unintentionally get bigger.
340 #[cfg(target_arch = "x86_64")]
341 static_assert_size!(ObligationCauseCode<'_>, 32);
343 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
344 pub enum StatementAsExpression {
349 impl<'tcx> ty::Lift<'tcx> for StatementAsExpression {
350 type Lifted = StatementAsExpression;
351 fn lift_to_tcx(self, _tcx: TyCtxt<'tcx>) -> Option<StatementAsExpression> {
356 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
357 pub struct MatchExpressionArmCause<'tcx> {
359 pub scrut_span: Span,
360 pub semi_span: Option<(Span, StatementAsExpression)>,
361 pub source: hir::MatchSource,
362 pub prior_arms: Vec<Span>,
363 pub last_ty: Ty<'tcx>,
364 pub scrut_hir_id: hir::HirId,
365 pub opt_suggest_box_span: Option<Span>,
368 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
369 pub struct IfExpressionCause {
372 pub outer: Option<Span>,
373 pub semicolon: Option<(Span, StatementAsExpression)>,
374 pub opt_suggest_box_span: Option<Span>,
377 #[derive(Clone, Debug, PartialEq, Eq, Hash, Lift)]
378 pub struct DerivedObligationCause<'tcx> {
379 /// The trait reference of the parent obligation that led to the
380 /// current obligation. Note that only trait obligations lead to
381 /// derived obligations, so we just store the trait reference here
383 pub parent_trait_ref: ty::PolyTraitRef<'tcx>,
385 /// The parent trait had this cause.
386 pub parent_code: Rc<ObligationCauseCode<'tcx>>,
389 #[derive(Clone, Debug, TypeFoldable, Lift)]
390 pub enum SelectionError<'tcx> {
392 OutputTypeParameterMismatch(
393 ty::PolyTraitRef<'tcx>,
394 ty::PolyTraitRef<'tcx>,
395 ty::error::TypeError<'tcx>,
397 TraitNotObjectSafe(DefId),
398 ConstEvalFailure(ErrorHandled),
402 /// When performing resolution, it is typically the case that there
403 /// can be one of three outcomes:
405 /// - `Ok(Some(r))`: success occurred with result `r`
406 /// - `Ok(None)`: could not definitely determine anything, usually due
407 /// to inconclusive type inference.
408 /// - `Err(e)`: error `e` occurred
409 pub type SelectionResult<'tcx, T> = Result<Option<T>, SelectionError<'tcx>>;
411 /// Given the successful resolution of an obligation, the `ImplSource`
412 /// indicates where the impl comes from.
414 /// For example, the obligation may be satisfied by a specific impl (case A),
415 /// or it may be relative to some bound that is in scope (case B).
418 /// impl<T:Clone> Clone<T> for Option<T> { ... } // Impl_1
419 /// impl<T:Clone> Clone<T> for Box<T> { ... } // Impl_2
420 /// impl Clone for i32 { ... } // Impl_3
422 /// fn foo<T: Clone>(concrete: Option<Box<i32>>, param: T, mixed: Option<T>) {
423 /// // Case A: Vtable points at a specific impl. Only possible when
424 /// // type is concretely known. If the impl itself has bounded
425 /// // type parameters, Vtable will carry resolutions for those as well:
426 /// concrete.clone(); // Vtable(Impl_1, [Vtable(Impl_2, [Vtable(Impl_3)])])
428 /// // Case A: ImplSource points at a specific impl. Only possible when
429 /// // type is concretely known. If the impl itself has bounded
430 /// // type parameters, ImplSource will carry resolutions for those as well:
431 /// concrete.clone(); // ImplSource(Impl_1, [ImplSource(Impl_2, [ImplSource(Impl_3)])])
433 /// // Case B: ImplSource must be provided by caller. This applies when
434 /// // type is a type parameter.
435 /// param.clone(); // ImplSource::Param
437 /// // Case C: A mix of cases A and B.
438 /// mixed.clone(); // ImplSource(Impl_1, [ImplSource::Param])
442 /// ### The type parameter `N`
444 /// See explanation on `ImplSourceUserDefinedData`.
445 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
446 pub enum ImplSource<'tcx, N> {
447 /// ImplSource identifying a particular impl.
448 UserDefined(ImplSourceUserDefinedData<'tcx, N>),
450 /// ImplSource for auto trait implementations.
451 /// This carries the information and nested obligations with regards
452 /// to an auto implementation for a trait `Trait`. The nested obligations
453 /// ensure the trait implementation holds for all the constituent types.
454 AutoImpl(ImplSourceAutoImplData<N>),
456 /// Successful resolution to an obligation provided by the caller
457 /// for some type parameter. The `Vec<N>` represents the
458 /// obligations incurred from normalizing the where-clause (if
462 /// Virtual calls through an object.
463 Object(ImplSourceObjectData<'tcx, N>),
465 /// Successful resolution for a builtin trait.
466 Builtin(ImplSourceBuiltinData<N>),
468 /// ImplSource automatically generated for a closure. The `DefId` is the ID
469 /// of the closure expression. This is a `ImplSource::UserDefined` in spirit, but the
470 /// impl is generated by the compiler and does not appear in the source.
471 Closure(ImplSourceClosureData<'tcx, N>),
473 /// Same as above, but for a function pointer type with the given signature.
474 FnPointer(ImplSourceFnPointerData<'tcx, N>),
476 /// ImplSource for a builtin `DeterminantKind` trait implementation.
477 DiscriminantKind(ImplSourceDiscriminantKindData),
479 /// ImplSource automatically generated for a generator.
480 Generator(ImplSourceGeneratorData<'tcx, N>),
482 /// ImplSource for a trait alias.
483 TraitAlias(ImplSourceTraitAliasData<'tcx, N>),
486 impl<'tcx, N> ImplSource<'tcx, N> {
487 pub fn nested_obligations(self) -> Vec<N> {
489 ImplSource::UserDefined(i) => i.nested,
490 ImplSource::Param(n) => n,
491 ImplSource::Builtin(i) => i.nested,
492 ImplSource::AutoImpl(d) => d.nested,
493 ImplSource::Closure(c) => c.nested,
494 ImplSource::Generator(c) => c.nested,
495 ImplSource::Object(d) => d.nested,
496 ImplSource::FnPointer(d) => d.nested,
497 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => Vec::new(),
498 ImplSource::TraitAlias(d) => d.nested,
502 pub fn borrow_nested_obligations(&self) -> &[N] {
504 ImplSource::UserDefined(i) => &i.nested[..],
505 ImplSource::Param(n) => &n[..],
506 ImplSource::Builtin(i) => &i.nested[..],
507 ImplSource::AutoImpl(d) => &d.nested[..],
508 ImplSource::Closure(c) => &c.nested[..],
509 ImplSource::Generator(c) => &c.nested[..],
510 ImplSource::Object(d) => &d.nested[..],
511 ImplSource::FnPointer(d) => &d.nested[..],
512 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => &[],
513 ImplSource::TraitAlias(d) => &d.nested[..],
517 pub fn map<M, F>(self, f: F) -> ImplSource<'tcx, M>
522 ImplSource::UserDefined(i) => ImplSource::UserDefined(ImplSourceUserDefinedData {
523 impl_def_id: i.impl_def_id,
525 nested: i.nested.into_iter().map(f).collect(),
527 ImplSource::Param(n) => ImplSource::Param(n.into_iter().map(f).collect()),
528 ImplSource::Builtin(i) => ImplSource::Builtin(ImplSourceBuiltinData {
529 nested: i.nested.into_iter().map(f).collect(),
531 ImplSource::Object(o) => ImplSource::Object(ImplSourceObjectData {
532 upcast_trait_ref: o.upcast_trait_ref,
533 vtable_base: o.vtable_base,
534 nested: o.nested.into_iter().map(f).collect(),
536 ImplSource::AutoImpl(d) => ImplSource::AutoImpl(ImplSourceAutoImplData {
537 trait_def_id: d.trait_def_id,
538 nested: d.nested.into_iter().map(f).collect(),
540 ImplSource::Closure(c) => ImplSource::Closure(ImplSourceClosureData {
541 closure_def_id: c.closure_def_id,
543 nested: c.nested.into_iter().map(f).collect(),
545 ImplSource::Generator(c) => ImplSource::Generator(ImplSourceGeneratorData {
546 generator_def_id: c.generator_def_id,
548 nested: c.nested.into_iter().map(f).collect(),
550 ImplSource::FnPointer(p) => ImplSource::FnPointer(ImplSourceFnPointerData {
552 nested: p.nested.into_iter().map(f).collect(),
554 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData) => {
555 ImplSource::DiscriminantKind(ImplSourceDiscriminantKindData)
557 ImplSource::TraitAlias(d) => ImplSource::TraitAlias(ImplSourceTraitAliasData {
558 alias_def_id: d.alias_def_id,
560 nested: d.nested.into_iter().map(f).collect(),
566 /// Identifies a particular impl in the source, along with a set of
567 /// substitutions from the impl's type/lifetime parameters. The
568 /// `nested` vector corresponds to the nested obligations attached to
569 /// the impl's type parameters.
571 /// The type parameter `N` indicates the type used for "nested
572 /// obligations" that are required by the impl. During type-check, this
573 /// is `Obligation`, as one might expect. During codegen, however, this
574 /// is `()`, because codegen only requires a shallow resolution of an
575 /// impl, and nested obligations are satisfied later.
576 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
577 pub struct ImplSourceUserDefinedData<'tcx, N> {
578 pub impl_def_id: DefId,
579 pub substs: SubstsRef<'tcx>,
583 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
584 pub struct ImplSourceGeneratorData<'tcx, N> {
585 pub generator_def_id: DefId,
586 pub substs: SubstsRef<'tcx>,
587 /// Nested obligations. This can be non-empty if the generator
588 /// signature contains associated types.
592 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
593 pub struct ImplSourceClosureData<'tcx, N> {
594 pub closure_def_id: DefId,
595 pub substs: SubstsRef<'tcx>,
596 /// Nested obligations. This can be non-empty if the closure
597 /// signature contains associated types.
601 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
602 pub struct ImplSourceAutoImplData<N> {
603 pub trait_def_id: DefId,
607 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
608 pub struct ImplSourceBuiltinData<N> {
612 #[derive(PartialEq, Eq, Clone, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
613 pub struct ImplSourceObjectData<'tcx, N> {
614 /// `Foo` upcast to the obligation trait. This will be some supertrait of `Foo`.
615 pub upcast_trait_ref: ty::PolyTraitRef<'tcx>,
617 /// The vtable is formed by concatenating together the method lists of
618 /// the base object trait and all supertraits; this is the start of
619 /// `upcast_trait_ref`'s methods in that vtable.
620 pub vtable_base: usize,
625 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
626 pub struct ImplSourceFnPointerData<'tcx, N> {
631 // FIXME(@lcnr): This should be refactored and merged with other builtin vtables.
632 #[derive(Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
633 pub struct ImplSourceDiscriminantKindData;
635 #[derive(Clone, PartialEq, Eq, TyEncodable, TyDecodable, HashStable, TypeFoldable, Lift)]
636 pub struct ImplSourceTraitAliasData<'tcx, N> {
637 pub alias_def_id: DefId,
638 pub substs: SubstsRef<'tcx>,
642 #[derive(Clone, Debug, PartialEq, Eq, Hash, HashStable)]
643 pub enum ObjectSafetyViolation {
644 /// `Self: Sized` declared on the trait.
645 SizedSelf(SmallVec<[Span; 1]>),
647 /// Supertrait reference references `Self` an in illegal location
648 /// (e.g., `trait Foo : Bar<Self>`).
649 SupertraitSelf(SmallVec<[Span; 1]>),
651 /// Method has something illegal.
652 Method(Symbol, MethodViolationCode, Span),
654 /// Associated const.
655 AssocConst(Symbol, Span),
658 impl ObjectSafetyViolation {
659 pub fn error_msg(&self) -> Cow<'static, str> {
661 ObjectSafetyViolation::SizedSelf(_) => "it requires `Self: Sized`".into(),
662 ObjectSafetyViolation::SupertraitSelf(ref spans) => {
663 if spans.iter().any(|sp| *sp != DUMMY_SP) {
664 "it uses `Self` as a type parameter".into()
666 "it cannot use `Self` as a type parameter in a supertrait or `where`-clause"
670 ObjectSafetyViolation::Method(name, MethodViolationCode::StaticMethod(_, _, _), _) => {
671 format!("associated function `{}` has no `self` parameter", name).into()
673 ObjectSafetyViolation::Method(
675 MethodViolationCode::ReferencesSelfInput(_),
677 ) => format!("method `{}` references the `Self` type in its parameters", name).into(),
678 ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfInput(_), _) => {
679 format!("method `{}` references the `Self` type in this parameter", name).into()
681 ObjectSafetyViolation::Method(name, MethodViolationCode::ReferencesSelfOutput, _) => {
682 format!("method `{}` references the `Self` type in its return type", name).into()
684 ObjectSafetyViolation::Method(
686 MethodViolationCode::WhereClauseReferencesSelf,
689 format!("method `{}` references the `Self` type in its `where` clause", name).into()
691 ObjectSafetyViolation::Method(name, MethodViolationCode::Generic, _) => {
692 format!("method `{}` has generic type parameters", name).into()
694 ObjectSafetyViolation::Method(name, MethodViolationCode::UndispatchableReceiver, _) => {
695 format!("method `{}`'s `self` parameter cannot be dispatched on", name).into()
697 ObjectSafetyViolation::AssocConst(name, DUMMY_SP) => {
698 format!("it contains associated `const` `{}`", name).into()
700 ObjectSafetyViolation::AssocConst(..) => "it contains this associated `const`".into(),
704 pub fn solution(&self, err: &mut DiagnosticBuilder<'_>) {
706 ObjectSafetyViolation::SizedSelf(_) | ObjectSafetyViolation::SupertraitSelf(_) => {}
707 ObjectSafetyViolation::Method(
709 MethodViolationCode::StaticMethod(sugg, self_span, has_args),
715 "consider turning `{}` into a method by giving it a `&self` argument",
718 format!("&self{}", if has_args { ", " } else { "" }),
719 Applicability::MaybeIncorrect,
722 Some((sugg, span)) => {
726 "alternatively, consider constraining `{}` so it does not apply to \
731 Applicability::MaybeIncorrect,
736 "consider turning `{}` into a method by giving it a `&self` \
737 argument or constraining it so it does not apply to trait objects",
743 ObjectSafetyViolation::Method(
745 MethodViolationCode::UndispatchableReceiver,
751 "consider changing method `{}`'s `self` parameter to be `&self`",
755 Applicability::MachineApplicable,
758 ObjectSafetyViolation::AssocConst(name, _)
759 | ObjectSafetyViolation::Method(name, ..) => {
760 err.help(&format!("consider moving `{}` to another trait", name));
765 pub fn spans(&self) -> SmallVec<[Span; 1]> {
766 // When `span` comes from a separate crate, it'll be `DUMMY_SP`. Treat it as `None` so
767 // diagnostics use a `note` instead of a `span_label`.
769 ObjectSafetyViolation::SupertraitSelf(spans)
770 | ObjectSafetyViolation::SizedSelf(spans) => spans.clone(),
771 ObjectSafetyViolation::AssocConst(_, span)
772 | ObjectSafetyViolation::Method(_, _, span)
773 if *span != DUMMY_SP =>
782 /// Reasons a method might not be object-safe.
783 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
784 pub enum MethodViolationCode {
786 StaticMethod(Option<(&'static str, Span)>, Span, bool /* has args */),
788 /// e.g., `fn foo(&self, x: Self)`
789 ReferencesSelfInput(usize),
791 /// e.g., `fn foo(&self) -> Self`
792 ReferencesSelfOutput,
794 /// e.g., `fn foo(&self) where Self: Clone`
795 WhereClauseReferencesSelf,
797 /// e.g., `fn foo<A>()`
800 /// the method's receiver (`self` argument) can't be dispatched on
801 UndispatchableReceiver,