Struct rustc_infer::traits::ProjectionCache

pub struct ProjectionCache<'a, 'tcx> {
    map: &'a mut SnapshotMapStorage<ProjectionCacheKey<'tcx>, ProjectionCacheEntry<'tcx>>,
    undo_log: &'a mut InferCtxtUndoLogs<'tcx>,
}

The projection cache. Unlike the standard caches, this can include infcx-dependent type variables, therefore we have to roll the cache back each time we roll a snapshot back, to avoid assumptions on yet-unresolved inference variables. Types with placeholder regions also have to be removed when the respective snapshot ends.

Because of that, projection cache entries can be "stranded" and left inaccessible when type variables inside the key are resolved. We make no attempt to recover or remove "stranded" entries, but rather let them be (for the lifetime of the infcx).

Entries in the projection cache might contain inference variables that will be resolved by obligations on the projection cache entry (e.g., when a type parameter in the associated type is constrained through an "RFC 447" projection on the impl).

When working with a fulfillment context, the derived obligations of each projection cache entry will be registered on the fulfillcx, so any users that can wait for a fulfillcx fixed point need not care about this. However, users that don't wait for a fixed point (e.g., trait evaluation) have to resolve the obligations themselves to make sure the projected result is ok and avoid issues like #43132.

If that is done, after evaluation the obligations, it is a good idea to call ProjectionCache::complete to make sure the obligations won't be re-evaluated and avoid an exponential worst-case.

Fields

map: &'a mut SnapshotMapStorage<ProjectionCacheKey<'tcx>, ProjectionCacheEntry<'tcx>>

undo_log: &'a mut InferCtxtUndoLogs<'tcx>

Implementations

impl<'tcx, '_> ProjectionCache<'_, 'tcx>

pub(in traits::project) fn map(
    &mut self
) -> SnapshotMapRef<'_, ProjectionCacheKey<'tcx>, ProjectionCacheEntry<'tcx>, InferCtxtUndoLogs<'tcx>>

pub fn clear(&mut self)

pub fn try_start(
    &mut self,
    key: ProjectionCacheKey<'tcx>
) -> Result<(), ProjectionCacheEntry<'tcx>>

Try to start normalize key; returns an error if normalization already occurred (this error corresponds to a cache hit, so it's actually a good thing).

pub fn insert_ty(
    &mut self,
    key: ProjectionCacheKey<'tcx>,
    value: NormalizedTy<'tcx>
)

Indicates that key was normalized to value.

pub fn complete(&mut self, key: ProjectionCacheKey<'tcx>)

Mark the relevant projection cache key as having its derived obligations complete, so they won't have to be re-computed (this is OK to do in a snapshot - if the snapshot is rolled back, the obligations will be marked as incomplete again).

pub fn complete_normalized(
    &mut self,
    key: ProjectionCacheKey<'tcx>,
    ty: &NormalizedTy<'tcx>
)

A specialized version of complete for when the key's value is known to be a NormalizedTy.

pub fn ambiguous(&mut self, key: ProjectionCacheKey<'tcx>)

Indicates that trying to normalize key resulted in ambiguity. No point in trying it again then until we gain more type information (in which case, the "fully resolved" key will be different).

pub fn error(&mut self, key: ProjectionCacheKey<'tcx>)

Indicates that trying to normalize key resulted in error.