Enum ObligationCauseCode

pub enum ObligationCauseCode<'tcx> {
    Misc,
    SliceOrArrayElem,
    TupleElem,
    WhereClause(DefId, Span),
    WhereClauseInExpr(DefId, Span, HirId, usize),
    ReferenceOutlivesReferent(Ty<'tcx>),
    ObjectTypeBound(Ty<'tcx>, Region<'tcx>),
    Coercion {
        source: Ty<'tcx>,
        target: Ty<'tcx>,
    },
    AssignmentLhsSized,
    TupleInitializerSized,
    StructInitializerSized,
    VariableType(HirId),
    SizedArgumentType(Option<HirId>),
    SizedReturnType,
    SizedCallReturnType,
    SizedYieldType,
    InlineAsmSized,
    SizedClosureCapture(LocalDefId),
    SizedCoroutineInterior(LocalDefId),
    RepeatElementCopy {
        is_constable: IsConstable,
        elt_type: Ty<'tcx>,
        elt_span: Span,
        elt_stmt_span: Span,
    },
    FieldSized {
        adt_kind: AdtKind,
        span: Span,
        last: bool,
    },
    ConstSized,
    SharedStatic,
    BuiltinDerived(DerivedCause<'tcx>),
    ImplDerived(Box<ImplDerivedCause<'tcx>>),
    WellFormedDerived(DerivedCause<'tcx>),
    FunctionArg {
        arg_hir_id: HirId,
        call_hir_id: HirId,
        parent_code: InternedObligationCauseCode<'tcx>,
    },
    CompareImplItem {
        impl_item_def_id: LocalDefId,
        trait_item_def_id: DefId,
        kind: AssocKind,
    },
    CheckAssociatedTypeBounds {
        impl_item_def_id: LocalDefId,
        trait_item_def_id: DefId,
    },
    ExprAssignable,
    MatchExpressionArm(Box<MatchExpressionArmCause<'tcx>>),
    Pattern {
        span: Option<Span>,
        root_ty: Ty<'tcx>,
        origin_expr: bool,
    },
    IfExpression(Box<IfExpressionCause<'tcx>>),
    IfExpressionWithNoElse,
    MainFunctionType,
    StartFunctionType,
    LangFunctionType(Symbol),
    IntrinsicType,
    LetElse,
    MethodReceiver,
    UnifyReceiver(Box<UnifyReceiverContext<'tcx>>),
    ReturnNoExpression,
    ReturnValue(HirId),
    OpaqueReturnType(Option<(Ty<'tcx>, HirId)>),
    BlockTailExpression(HirId, MatchSource),
    TrivialBound,
    AwaitableExpr(HirId),
    ForLoopIterator,
    QuestionMark,
    WellFormed(Option<WellFormedLoc>),
    MatchImpl(ObligationCause<'tcx>, DefId),
    BinOp {
        lhs_hir_id: HirId,
        rhs_hir_id: Option<HirId>,
        rhs_span: Option<Span>,
        rhs_is_lit: bool,
        output_ty: Option<Ty<'tcx>>,
    },
    AscribeUserTypeProvePredicate(Span),
    RustCall,
    DropImpl,
    ConstParam(Ty<'tcx>),
    TypeAlias(InternedObligationCauseCode<'tcx>, Span, DefId),
}

Variants

Misc

Not well classified or should be obvious from the span.

SliceOrArrayElem

A slice or array is WF only if T: Sized.

TupleElem

A tuple is WF only if its middle elements are Sized.

WhereClause(DefId, Span)

Represents a clause that comes from a specific item. The span corresponds to the clause.

WhereClauseInExpr(DefId, Span, HirId, usize)

Like WhereClause, but also identifies the expression which requires the where clause to be proven, and also identifies the index of the predicate in the predicates_of list of the item.

ReferenceOutlivesReferent(Ty<'tcx>)

A type like &'a T is WF only if T: 'a.

ObjectTypeBound(Ty<'tcx>, Region<'tcx>)

A type like Box<Foo<'a> + 'b> is WF only if 'b: 'a.

Coercion

Obligation incurred due to a coercion.

Fields

source: Ty<'tcx>

target: Ty<'tcx>

AssignmentLhsSized

Various cases where expressions must be Sized / Copy / etc. L = X implies that L is Sized.

TupleInitializerSized

(x1, .., xn) must be Sized.

StructInitializerSized

S { ... } must be Sized.

VariableType(HirId)

Type of each variable must be Sized.

SizedArgumentType(Option<HirId>)

Argument type must be Sized.

SizedReturnType

Return type must be Sized.

SizedCallReturnType

Return type of a call expression must be Sized.

SizedYieldType

Yield type must be Sized.

InlineAsmSized

Inline asm operand type must be Sized.

SizedClosureCapture(LocalDefId)

Captured closure type must be Sized.

SizedCoroutineInterior(LocalDefId)

Types live across coroutine yields must be Sized.

RepeatElementCopy

[expr; N] requires type_of(expr): Copy.

Fields

is_constable: IsConstable

If element is a const fn or const ctor we display a help message suggesting to move it to a new const item while saying that T doesn’t implement Copy.

elt_type: Ty<'tcx>

elt_span: Span

elt_stmt_span: Span

Span of the statement/item in which the repeat expression occurs. We can use this to place a const declaration before it

FieldSized

Types of fields (other than the last, except for packed structs) in a struct must be sized.

Fields

adt_kind: AdtKind

span: Span

last: bool

ConstSized

Constant expressions must be sized.

SharedStatic

static items must have Sync type.

BuiltinDerived(DerivedCause<'tcx>)

Derived obligation (i.e. theoretical where clause) on a built-in implementation like Copy or Sized.

ImplDerived(Box<ImplDerivedCause<'tcx>>)

Derived obligation (i.e. where clause) on an user-provided impl or a trait alias.

WellFormedDerived(DerivedCause<'tcx>)

Derived obligation for WF goals.

FunctionArg

Derived obligation refined to point at a specific argument in a call or method expression.

Fields

arg_hir_id: HirId

The node of the relevant argument in the function call.

call_hir_id: HirId

The node of the function call.

parent_code: InternedObligationCauseCode<'tcx>

The obligation introduced by this argument.

CompareImplItem

Error derived when checking an impl item is compatible with its corresponding trait item’s definition

Fields

impl_item_def_id: LocalDefId

trait_item_def_id: DefId

kind: AssocKind

CheckAssociatedTypeBounds

Checking that the bounds of a trait’s associated type hold for a given impl

Fields

impl_item_def_id: LocalDefId

trait_item_def_id: DefId

ExprAssignable

Checking that this expression can be assigned to its target.

MatchExpressionArm(Box<MatchExpressionArmCause<'tcx>>)

Computing common supertype in the arms of a match expression

Pattern

Type error arising from type checking a pattern against an expected type.

Fields

span: Option<Span>

The span of the scrutinee or type expression which caused the root_ty type.

root_ty: Ty<'tcx>

The root expected type induced by a scrutinee or type expression.

origin_expr: bool

Whether the Span came from an expression or a type expression.

IfExpression(Box<IfExpressionCause<'tcx>>)

Computing common supertype in an if expression

IfExpressionWithNoElse

Computing common supertype of an if expression with no else counter-part

MainFunctionType

main has wrong type

StartFunctionType

start has wrong type

LangFunctionType(Symbol)

language function has wrong type

IntrinsicType

Intrinsic has wrong type

LetElse

A let else block does not diverge

MethodReceiver

Method receiver

UnifyReceiver(Box<UnifyReceiverContext<'tcx>>)

ReturnNoExpression

return with no expression

ReturnValue(HirId)

return with an expression

OpaqueReturnType(Option<(Ty<'tcx>, HirId)>)

Opaque return type of this function

BlockTailExpression(HirId, MatchSource)

Block implicit return

TrivialBound

#[feature(trivial_bounds)] is not enabled

AwaitableExpr(HirId)

ForLoopIterator

QuestionMark

WellFormed(Option<WellFormedLoc>)

Well-formed checking. If a WellFormedLoc is provided, then it will be used to perform HIR-based wf checking after an error occurs, in order to generate a more precise error span. This is purely for diagnostic purposes - it is always correct to use Misc instead, or to specify WellFormed(None).

MatchImpl(ObligationCause<'tcx>, DefId)

From match_impl. The cause for us having to match an impl, and the DefId we are matching against.

BinOp

Fields

lhs_hir_id: HirId

rhs_hir_id: Option<HirId>

rhs_span: Option<Span>

rhs_is_lit: bool

output_ty: Option<Ty<'tcx>>

AscribeUserTypeProvePredicate(Span)

RustCall

DropImpl

Obligations to prove that a std::ops::Drop impl is not stronger than the ADT it’s being implemented for.

ConstParam(Ty<'tcx>)

Requirement for a const N: Ty to implement Ty: ConstParamTy

TypeAlias(InternedObligationCauseCode<'tcx>, Span, DefId)

Obligations emitted during the normalization of a weak type alias.

Implementations

impl<'tcx> ObligationCauseCode<'tcx>

pub fn peel_derives(&self) -> &ObligationCauseCode<'tcx>

Returns the base obligation, ignoring derived obligations.

pub fn peel_derives_with_predicate( &self, ) -> (&ObligationCauseCode<'tcx>, Option<Binder<TyCtxt<'tcx>, TraitPredicate<TyCtxt<'tcx>>>>)

Returns the base obligation and the base trait predicate, if any, ignoring derived obligations.

pub fn parent( &self, ) -> Option<(&ObligationCauseCode<'tcx>, Option<Binder<TyCtxt<'tcx>, TraitPredicate<TyCtxt<'tcx>>>>)>

pub fn peel_match_impls(&self) -> &ObligationCauseCode<'tcx>

Trait Implementations

impl<'tcx> Clone for ObligationCauseCode<'tcx>

fn clone(&self) -> ObligationCauseCode<'tcx>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'tcx> Debug for ObligationCauseCode<'tcx>

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'tcx, __D> Decodable<__D> for ObligationCauseCode<'tcx>

where __D: TyDecoder<I = TyCtxt<'tcx>>,

fn decode(__decoder: &mut __D) -> ObligationCauseCode<'tcx>

impl<'tcx, __E> Encodable<__E> for ObligationCauseCode<'tcx>

where __E: TyEncoder<I = TyCtxt<'tcx>>,

fn encode(&self, __encoder: &mut __E)

impl<'tcx, '__ctx> HashStable<StableHashingContext<'__ctx>> for ObligationCauseCode<'tcx>

fn hash_stable( &self, __hcx: &mut StableHashingContext<'__ctx>, __hasher: &mut StableHasher<SipHasher128>, )

impl<'tcx> PartialEq for ObligationCauseCode<'tcx>

fn eq(&self, other: &ObligationCauseCode<'tcx>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for ObligationCauseCode<'tcx>

fn try_fold_with<__F>( self, __folder: &mut __F, ) -> Result<ObligationCauseCode<'tcx>, <__F as FallibleTypeFolder<TyCtxt<'tcx>>>::Error>

where __F: FallibleTypeFolder<TyCtxt<'tcx>>,

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F>(self, folder: &mut F) -> Self

where F: TypeFolder<I>,

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for ObligationCauseCode<'tcx>

fn visit_with<__V>( &self, __visitor: &mut __V, ) -> <__V as TypeVisitor<TyCtxt<'tcx>>>::Result

where __V: TypeVisitor<TyCtxt<'tcx>>,

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

impl<'tcx> Eq for ObligationCauseCode<'tcx>

impl<'tcx> StructuralPartialEq for ObligationCauseCode<'tcx>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 48 bytes

Size for each variant:

• Misc: 0 bytes
• SliceOrArrayElem: 0 bytes
• TupleElem: 0 bytes
• WhereClause: 19 bytes
• WhereClauseInExpr: 39 bytes
• ReferenceOutlivesReferent: 15 bytes
• ObjectTypeBound: 23 bytes
• Coercion: 23 bytes
• AssignmentLhsSized: 0 bytes
• TupleInitializerSized: 0 bytes
• StructInitializerSized: 0 bytes
• VariableType: 11 bytes
• SizedArgumentType: 11 bytes
• SizedReturnType: 0 bytes
• SizedCallReturnType: 0 bytes
• SizedYieldType: 0 bytes
• InlineAsmSized: 0 bytes
• SizedClosureCapture: 7 bytes
• SizedCoroutineInterior: 7 bytes
• RepeatElementCopy: 31 bytes
• FieldSized: 11 bytes
• ConstSized: 0 bytes
• SharedStatic: 0 bytes
• BuiltinDerived: 47 bytes
• ImplDerived: 15 bytes
• WellFormedDerived: 47 bytes
• FunctionArg: 31 bytes
• CompareImplItem: 15 bytes
• CheckAssociatedTypeBounds: 15 bytes
• ExprAssignable: 0 bytes
• MatchExpressionArm: 15 bytes
• Pattern: 23 bytes
• IfExpression: 15 bytes
• IfExpressionWithNoElse: 0 bytes
• MainFunctionType: 0 bytes
• StartFunctionType: 0 bytes
• LangFunctionType: 7 bytes
• IntrinsicType: 0 bytes
• LetElse: 0 bytes
• MethodReceiver: 0 bytes
• UnifyReceiver: 15 bytes
• ReturnNoExpression: 0 bytes
• ReturnValue: 11 bytes
• OpaqueReturnType: 23 bytes
• BlockTailExpression: 19 bytes
• TrivialBound: 0 bytes
• AwaitableExpr: 11 bytes
• ForLoopIterator: 0 bytes
• QuestionMark: 0 bytes
• WellFormed: 23 bytes
• MatchImpl: 39 bytes
• BinOp: 39 bytes
• AscribeUserTypeProvePredicate: 11 bytes
• RustCall: 0 bytes
• DropImpl: 0 bytes
• ConstParam: 15 bytes
• TypeAlias: 31 bytes