CStore in rustc_metadata::creader - Rust
Description: API documentation for the Rust `CStore` struct in crate `rustc_metadata`.

Skip to main content

## CStore

# Struct CStore

Source

    pub struct CStore {
        metadata_loader: Box<MetadataLoaderDyn>,
        metas: IndexVec<CrateNum, Option<Box<CrateMetadata>>>,
        injected_panic_runtime: Option<CrateNum>,
        allocator_kind: Option<AllocatorKind>,
        alloc_error_handler_kind: Option<AllocatorKind>,
        has_global_allocator: bool,
        has_alloc_error_handler: bool,
        resolved_externs: UnordMap<Symbol, CrateNum>,
        unused_externs: Vec<Symbol>,
        used_extern_options: FxHashSet<Symbol>,
        has_crate_resolve_with_fail: bool,
    }

## Fields§

§`metadata_loader: Box<MetadataLoaderDyn>`§`metas: IndexVec<CrateNum, Option<Box<CrateMetadata>>>`§`injected_panic_runtime: Option<CrateNum>`§`allocator_kind: Option<AllocatorKind>`

This crate needs an allocator and either provides it itself, or finds it in a dependency. If the above is true, then this field denotes the kind of the found allocator.

§`alloc_error_handler_kind: Option<AllocatorKind>`

This crate needs an allocation error handler and either provides it itself, or finds it in a dependency. If the above is true, then this field denotes the kind of the found allocator.

§`has_global_allocator: bool`

This crate has a `#[global_allocator]` item.

§`has_alloc_error_handler: bool`

This crate has a `#[alloc_error_handler]` item.

§`resolved_externs: UnordMap<Symbol, CrateNum>`

Names that were used to load the crates via `extern crate` or paths.

§`unused_externs: Vec<Symbol>`

Unused externs of the crate

§`used_extern_options: FxHashSet<Symbol>`§`has_crate_resolve_with_fail: bool`

Whether there was a failure in resolving crate, it’s used to suppress some diagnostics that would otherwise too noisey.

## Implementations§

Source§

### impl CStore

Source

#### pub fn ctor_untracked( &self, tcx: TyCtxt<'_>, def: DefId, ) -> Option<(CtorKind, DefId)>

Source

#### pub fn load_macro_untracked(&self, tcx: TyCtxt<'_>, id: DefId) -> LoadedMacro

Source

#### pub fn def_span_untracked(&self, tcx: TyCtxt<'_>, def_id: DefId) -> Span

Source

#### pub fn def_kind_untracked(&self, def: DefId) -> DefKind

Source

#### pub fn expn_that_defined_untracked( &self, tcx: TyCtxt<'_>, def_id: DefId, ) -> ExpnId

Source

#### pub fn ambig_module_children_untracked( &self, tcx: TyCtxt<'_>, def_id: DefId, ) -> impl Iterator<Item = AmbigModChild>

Source

#### pub fn num_def_ids_untracked(&self, cnum: CrateNum) -> usize

Only public-facing way to traverse all the definitions in a non-local crate. Critically useful for this third-party project: https://github.com/hacspec/hacspec. See https://github.com/rust-lang/rust/pull/85889 for context.

Source

#### pub fn get_proc_macro_quoted_span_untracked( &self, tcx: TyCtxt<'_>, cnum: CrateNum, id: usize, ) -> Span

Source

#### pub fn set_used_recursively(&mut self, cnum: CrateNum)

Source

#### pub(crate) fn update_extern_crate( &mut self, cnum: CrateNum, name: Symbol, extern_crate: ExternCrate, )

Track how an extern crate has been loaded. Called after resolving an import in the local crate.

- the `name` is for `Self::set_resolved_extern_crate_name` saving `--extern name=`
- `extern_crate` is for diagnostics

Source

#### fn update_transitive_extern_crate_diagnostics( &mut self, cnum: CrateNum, extern_crate: ExternCrate, )

`CrateMetadata` uses `ExternCrate` only for diagnostics

Source§

### impl CStore

Source

#### pub fn from_tcx(tcx: TyCtxt<'_>) -> FreezeReadGuard<'_, CStore>

Source

#### pub fn from_tcx_mut(tcx: TyCtxt<'_>) -> FreezeWriteGuard<'_, CStore>

Source

#### fn intern_stable_crate_id<'tcx>( &mut self, tcx: TyCtxt<'tcx>, root: &CrateRoot, ) -> Result<TyCtxtFeed<'tcx, CrateNum>, CrateError>

Source

#### pub fn has_crate_data(&self, cnum: CrateNum) -> bool

Source

#### pub(crate) fn get_crate_data(&self, cnum: CrateNum) -> &CrateMetadata

Source

#### pub(crate) fn get_crate_data_mut( &mut self, cnum: CrateNum, ) -> &mut CrateMetadata

Source

#### fn set_crate_data(&mut self, cnum: CrateNum, data: CrateMetadata)

Source

#### pub(crate) fn set_resolved_extern_crate_name( &mut self, name: Symbol, extern_crate: CrateNum, )

Save the name used to resolve the extern crate in the local crate

The name isn’t always the crate’s own name, because `sess.opts.externs` can assign it another name. It’s also not always the same as the `DefId`’s symbol due to renames `extern crate resolved_name as defid_name`.

Source

#### pub fn resolved_extern_crate(&self, externs_name: Symbol) -> Option<CrateNum>

Crate resolved and loaded via the given extern name (corresponds to names in `sess.opts.externs`)

May be `None` if the crate wasn’t used

Source

#### pub(crate) fn iter_crate_data( &self, ) -> impl Iterator<Item = (CrateNum, &CrateMetadata)>

Source

#### pub fn all_proc_macro_def_ids( &self, tcx: TyCtxt<'_>, ) -> impl Iterator<Item = DefId>

Source

#### fn push_dependencies_in_postorder( &self, deps: &mut IndexSet<CrateNum>, cnum: CrateNum, )

Source

#### pub(crate) fn crate_dependencies_in_postorder( &self, cnum: CrateNum, ) -> IndexSet<CrateNum>

Source

#### pub(crate) fn injected_panic_runtime(&self) -> Option<CrateNum>

Source

#### pub(crate) fn allocator_kind(&self) -> Option<AllocatorKind>

Source

#### pub(crate) fn alloc_error_handler_kind(&self) -> Option<AllocatorKind>

Source

#### pub(crate) fn has_global_allocator(&self) -> bool

Source

#### pub(crate) fn has_alloc_error_handler(&self) -> bool

Source

#### pub fn had_extern_crate_load_failure(&self) -> bool

Source

#### pub fn report_unused_deps(&self, tcx: TyCtxt<'_>)

Source

#### fn report_target_modifiers_extended( tcx: TyCtxt<'_>, krate: &Crate, mods: &Vec<TargetModifier>, dep_mods: &Vec<TargetModifier>, data: &CrateMetadata, )

Source

#### pub fn report_session_incompatibilities(&self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### pub fn report_incompatible_target_modifiers( &self, tcx: TyCtxt<'_>, krate: &Crate, )

Source

#### pub fn report_incompatible_partial_mitigations( &self, tcx: TyCtxt<'_>, krate: &Crate, )

Source

#### pub fn report_incompatible_async_drop_feature( &self, tcx: TyCtxt<'_>, krate: &Crate, )

Source

#### pub fn new(metadata_loader: Box<MetadataLoaderDyn>) -> CStore

Source

#### fn existing_match(&self, name: Symbol, hash: Option<Svh>) -> Option<CrateNum>

Source

#### fn is_private_dep( &self, externs: &Externs, name: Symbol, private_dep: Option<bool>, ) -> bool

Determine whether a dependency should be considered private.

Dependencies are private if they get extern option specified, e.g. `--extern priv:mycrate`. This is stored in metadata, so `private_dep` can be correctly set during load. A `Some` value for `private_dep` indicates that the crate is known to be private or public (note that any `None` or `Some(false)` use of the same crate will make it public).

Sometimes the directly dependent crate is not specified by `--extern`, in this case, `private-dep` is none during loading. This is equivalent to the scenario where the command parameter is set to `public-dependency`

Source

#### fn register_crate<'tcx>( &mut self, tcx: TyCtxt<'tcx>, host_lib: Option<Library>, origin: CrateOrigin<'_>, lib: Library, dep_kind: CrateDepKind, name: Symbol, private_dep: Option<bool>, ) -> Result<CrateNum, CrateError>

Source

#### fn load_proc_macro<'a, 'b>( &self, sess: &'a Session, locator: &mut CrateLocator<'b>, crate_rejections: &mut CrateRejections, path_kind: PathKind, host_hash: Option<Svh>, ) -> Result<Option<(LoadResult, Option<Library>)>, CrateError>
where 'a: 'b,

Source

#### fn resolve_crate<'tcx>( &mut self, tcx: TyCtxt<'tcx>, name: Symbol, span: Span, dep_kind: CrateDepKind, origin: CrateOrigin<'_>, ) -> Option<CrateNum>

Source

#### fn maybe_resolve_crate<'b, 'tcx>( &'b mut self, tcx: TyCtxt<'tcx>, name: Symbol, dep_kind: CrateDepKind, origin: CrateOrigin<'b>, ) -> Result<CrateNum, CrateError>

Source

#### fn load( &self, locator: &CrateLocator<'_>, crate_rejections: &mut CrateRejections, ) -> Result<Option<LoadResult>, CrateError>

Source

#### fn resolve_crate_deps( &mut self, tcx: TyCtxt<'_>, dep_root_for_errors: &CratePaths, crate_root: &CrateRoot, metadata: &MetadataBlob, krate: CrateNum, dep_kind: CrateDepKind, parent_is_private: bool, ) -> Result<IndexVec<CrateNum, CrateNum>, CrateError>

Go through the crate metadata and load any crates that it references.

Source

#### fn dlsym_proc_macros( &self, sess: &Session, path: &Path, stable_crate_id: StableCrateId, ) -> Result<&'static [ProcMacro], CrateError>

Source

#### fn inject_panic_runtime(&mut self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### fn inject_profiler_runtime(&mut self, tcx: TyCtxt<'_>)

Source

#### fn inject_allocator_crate(&mut self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### fn inject_forced_externs(&mut self, tcx: TyCtxt<'_>)

Source

#### fn inject_compiler_builtins(&mut self, tcx: TyCtxt<'_>, krate: &Crate)

Inject the `compiler_builtins` crate if it is not already in the graph.

Source

#### fn report_unused_deps_in_crate(&mut self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### fn report_future_incompatible_deps(&self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### pub fn postprocess(&mut self, tcx: TyCtxt<'_>, krate: &Crate)

Source

#### pub fn process_extern_crate( &mut self, tcx: TyCtxt<'_>, item: &Item, def_id: LocalDefId, definitions: &Definitions, ) -> Option<CrateNum>

Process an `extern crate foo` AST node.

Source

#### pub fn process_path_extern( &mut self, tcx: TyCtxt<'_>, name: Symbol, span: Span, ) -> Option<CrateNum>

Source

#### pub fn maybe_process_path_extern( &mut self, tcx: TyCtxt<'_>, name: Symbol, ) -> Option<CrateNum>

## Trait Implementations§

Source§

### impl CrateStore for CStore

Source§

#### fn def_key(&self, def: DefId) -> DefKey

Returns the `DefKey` for a given `DefId`. This indicates the parent `DefId` as well as some idea of what kind of data the `DefId` refers to.

Source§

#### fn as_any(&self) -> &dyn Any

Source§

#### fn untracked_as_any(&mut self) -> &mut dyn Any

Source§

#### fn crate_name(&self, cnum: CrateNum) -> Symbol

Source§

#### fn stable_crate_id(&self, cnum: CrateNum) -> StableCrateId

Source§

#### fn def_path(&self, def: DefId) -> DefPath

Source§

#### fn def_path_hash(&self, def: DefId) -> DefPathHash

Source§

### impl Debug for CStore

Source§

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

Formats the value using the given formatter. Read more

## Auto Trait Implementations§

§

### impl !RefUnwindSafe for CStore

§

### impl !Send for CStore

§

### impl !Sync for CStore

§

### impl !UnwindSafe for CStore

§

### impl DynSend for CStore

§

### impl DynSync for CStore

§

### impl Freeze for CStore

§

### impl Unpin for CStore

§

### impl UnsafeUnpin for CStore

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