Config in rustc_interface::interface - Rust
Description: The compiler configuration

Skip to main content

## Config

# Struct Config

Source

    pub struct Config {Show 16 fields
        pub opts: Options,
        pub crate_cfg: Vec<String>,
        pub crate_check_cfg: Vec<String>,
        pub input: Input,
        pub output_dir: Option<PathBuf>,
        pub output_file: Option<OutFileName>,
        pub ice_file: Option<PathBuf>,
        pub file_loader: Option<Box<dyn FileLoader + Send + Sync>>,
        pub lint_caps: FxHashMap<LintId, Level>,
        pub psess_created: Option<Box<dyn FnOnce(&mut ParseSess) + Send>>,
        pub track_state: Option<Box<dyn FnOnce(&Session, &mut StableHasher) + Send>>,
        pub register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>,
        pub override_queries: Option<fn(&Session, &mut Providers)>,
        pub extra_symbols: Vec<&'static str>,
        pub make_codegen_backend: Option<Box<dyn FnOnce(&Session) -> Box<dyn CodegenBackend> + Send>>,
        pub using_internal_features: &'static AtomicBool,
    }

Expand description

The compiler configuration

## Fields§

§`opts: Options`

Command line options

§`crate_cfg: Vec<String>`

Unparsed cfg! configuration in addition to the default ones.

§`crate_check_cfg: Vec<String>`§`input: Input`§`output_dir: Option<PathBuf>`§`output_file: Option<OutFileName>`§`ice_file: Option<PathBuf>`§`file_loader: Option<Box<dyn FileLoader + Send + Sync>>`

Load files from sources other than the file system.

Has no uses within this repository, but may be used in the future by bjorn3 for “hooking rust-analyzer’s VFS into rustc at some point for running rustc without having to save”. (See #102759.)

§`lint_caps: FxHashMap<LintId, Level>`§`psess_created: Option<Box<dyn FnOnce(&mut ParseSess) + Send>>`

This is a callback from the driver that is called when `ParseSess` is created.

§`track_state: Option<Box<dyn FnOnce(&Session, &mut StableHasher) + Send>>`

This is a callback to track otherwise untracked state used by the caller.

You can write to `sess.env_depinfo` and `sess.file_depinfo` to track env vars and files. To track any other state you can write to the given hasher. If the hash changes between runs the incremental cache will be cleared.

The hashing functionality has no known user. FIXME should this be removed?

§`register_lints: Option<Box<dyn Fn(&Session, &mut LintStore) + Send + Sync>>`

This is a callback from the driver that is called when we’re registering lints; it is called during lint loading when we have the LintStore in a non-shared state.

Note that if you find a Some here you probably want to call that function in the new function being registered.

§`override_queries: Option<fn(&Session, &mut Providers)>`

This is a callback from the driver that is called just after we have populated the list of queries.

§`extra_symbols: Vec<&'static str>`

An extra set of symbols to add to the symbol interner, the symbol indices will start at `PREDEFINED_SYMBOLS_COUNT`

§`make_codegen_backend: Option<Box<dyn FnOnce(&Session) -> Box<dyn CodegenBackend> + Send>>`

This is a callback from the driver that is called to create a codegen backend.

Has no uses within this repository, but is used by bjorn3 for “the hotswapping branch of cg_clif” for “setting the codegen backend from a custom driver where the custom codegen backend has arbitrary data.” (See #102759.)

§`using_internal_features: &'static AtomicBool`

The inner atomic value is set to true when a feature marked as `internal` is enabled. Makes it so that “please report a bug” is hidden, as ICEs with internal features are wontfix, and they are usually the cause of the ICEs.

## Auto Trait Implementations§

§

### impl !DynSend for Config

§

### impl !DynSync for Config

§

### impl Freeze for Config

§

### impl !RefUnwindSafe for Config

§

### impl Send for Config

§

### impl !Sync for Config

§

### impl Unpin for Config

§

### impl UnsafeUnpin for Config

§

### impl !UnwindSafe for Config

## 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> 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
Source§

### impl<'a, T> Captures<'a> for T
where T: ?Sized,

Source§

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

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