OnDiskCache in rustc_middle::query::on_disk_cache - Rust
Description: Provides an interface to incremental compilation data cached from the previous compilation session. This data will eventually include the results of a few selected queries (like `typeck` and `mir_optimized`) and any side effects that have been emitted during a query.

Skip to main content

## OnDiskCache

# Struct OnDiskCache

Source

    pub struct OnDiskCache {
        serialized_data: RwLock<Option<Mmap>>,
        file_index_to_stable_id: FxHashMap<SourceFileIndex, EncodedSourceFileId>,
        file_index_to_file: Lock<FxHashMap<SourceFileIndex, Arc<SourceFile>>>,
        query_values_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>,
        side_effects_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>,
        alloc_decoding_state: AllocDecodingState,
        syntax_contexts: FxHashMap<u32, AbsoluteBytePos>,
        expn_data: UnhashMap<ExpnHash, AbsoluteBytePos>,
        hygiene_context: HygieneDecodeContext,
        foreign_expn_data: UnhashMap<ExpnHash, u32>,
    }

Expand description

Provides an interface to incremental compilation data cached from the previous compilation session. This data will eventually include the results of a few selected queries (like `typeck` and `mir_optimized`) and any side effects that have been emitted during a query.

## Fields§

§`serialized_data: RwLock<Option<Mmap>>`§`file_index_to_stable_id: FxHashMap<SourceFileIndex, EncodedSourceFileId>`§`file_index_to_file: Lock<FxHashMap<SourceFileIndex, Arc<SourceFile>>>`§`query_values_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>`

For query dep nodes that have a disk-cached return value, maps the node index to the position of its serialized value in `serialized_data`.

§`side_effects_index: FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>`

For `DepKind::SideEffect` dep nodes, maps the node index to the position of its serialized `QuerySideEffect` in `serialized_data`.

§`alloc_decoding_state: AllocDecodingState`§`syntax_contexts: FxHashMap<u32, AbsoluteBytePos>`§`expn_data: UnhashMap<ExpnHash, AbsoluteBytePos>`§`hygiene_context: HygieneDecodeContext`§`foreign_expn_data: UnhashMap<ExpnHash, u32>`

## Implementations§

Source§

### impl OnDiskCache

Source

#### pub fn new(sess: &Session, data: Mmap, start_pos: usize) -> Result<Self, ()>

Creates a new `OnDiskCache` instance from the serialized data in `data`.

The serialized cache has some basic integrity checks, if those checks indicate that the on-disk data is corrupt, an error is returned.

Source

#### pub fn new_empty() -> Self

Source

#### pub fn close_serialized_data_mmap(&self)

Release the serialized backing `Mmap`.

Source

#### pub fn serialize(tcx: TyCtxt<'_>, encoder: FileEncoder) -> FileEncodeResult

Serialize the current-session data that will be loaded by `OnDiskCache` in a subsequent incremental compilation session.

Source

#### pub(crate) fn load_side_effect( &self, tcx: TyCtxt<'_>, dep_node_index: SerializedDepNodeIndex, ) -> Option<QuerySideEffect>

Loads a `QuerySideEffect` created during the previous compilation session.

Source

#### pub fn loadable_from_disk(&self, dep_node_index: SerializedDepNodeIndex) -> bool

Returns true if there is a disk-cached query return value for the given node.

Source

#### pub fn try_load_query_value<'tcx, T>( &self, tcx: TyCtxt<'tcx>, dep_node_index: SerializedDepNodeIndex, ) -> Option<T>
where T: for<'a> Decodable<CacheDecoder<'a, 'tcx>>,

Returns the disk-cached query return value for the given node, if there is one.

Source

#### fn load_indexed<'tcx, T>( &self, tcx: TyCtxt<'tcx>, dep_node_index: SerializedDepNodeIndex, index: &FxHashMap<SerializedDepNodeIndex, AbsoluteBytePos>, ) -> Option<T>
where T: for<'a> Decodable<CacheDecoder<'a, 'tcx>>,

Source

#### fn with_decoder<'a, 'tcx, T, F: for<'s> FnOnce(&mut CacheDecoder<'s, 'tcx>) -> T>( &self, tcx: TyCtxt<'tcx>, pos: AbsoluteBytePos, f: F, ) -> T
where T: Decodable<CacheDecoder<'a, 'tcx>>,

## Auto Trait Implementations§

§

### impl !Freeze for OnDiskCache

§

### impl !RefUnwindSafe for OnDiskCache

§

### impl !Send for OnDiskCache

§

### impl !Sync for OnDiskCache

§

### impl !UnwindSafe for OnDiskCache

§

### impl DynSend for OnDiskCache

§

### impl DynSync for OnDiskCache

§

### impl Unpin for OnDiskCache

§

### impl UnsafeUnpin for OnDiskCache

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> ErasedDestructor for T
where T: 'static,

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more

## 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: 344 bytes