Struct rustc_middle::traits::ObligationCause

pub struct ObligationCause<'tcx> {
    pub span: Span,
    pub body_id: HirId,
    code: Option<Lrc<ObligationCauseCode<'tcx>>>,
}

The reason why we incurred this obligation; used for error reporting.

Non-misc ObligationCauseCodes are stored on the heap. This gives the best trade-off between keeping the type small (which makes copies cheaper) while not doing too many heap allocations.

We do not want to intern this as there are a lot of obligation causes which only live for a short period of time.

Fields

span: Span

body_id: HirId

The ID of the fn body that triggered this obligation. This is used for region obligations to determine the precise environment in which the region obligation should be evaluated (in particular, closures can add new assumptions). See the field region_obligations of the FulfillmentContext for more information.

code: Option<Lrc<ObligationCauseCode<'tcx>>>

None for MISC_OBLIGATION_CAUSE_CODE (a common case, occurs ~60% of the time). Some otherwise.

Implementations

impl<'tcx> ObligationCause<'tcx>

pub fn new(
    span: Span,
    body_id: HirId,
    code: ObligationCauseCode<'tcx>
) -> ObligationCause<'tcx>

pub fn misc(span: Span, body_id: HirId) -> ObligationCause<'tcx>

pub fn dummy() -> ObligationCause<'tcx>

pub fn dummy_with_span(span: Span) -> ObligationCause<'tcx>

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

pub fn span(&self, tcx: TyCtxt<'tcx>) -> Span

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

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

Trait Implementations

impl<'tcx> Clone for ObligationCause<'tcx>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Debug for ObligationCause<'tcx>

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

Formats the value using the given formatter.

impl Hash for ObligationCause<'_>

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'tcx, '__lifted> Lift<'__lifted> for ObligationCause<'tcx>

type Lifted = ObligationCause<'__lifted>

fn lift_to_tcx(
    self,
    __tcx: TyCtxt<'__lifted>
) -> Option<ObligationCause<'__lifted>>

impl<'tcx> PartialEq<ObligationCause<'tcx>> for ObligationCause<'tcx>

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ObligationCause<'tcx>) -> bool

This method tests for !=.

impl<'tcx> Eq for ObligationCause<'tcx>

impl<'tcx> StructuralEq for ObligationCause<'tcx>

impl<'tcx> StructuralPartialEq for ObligationCause<'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: 24 bytes