DrainState in cargo::core::compiler::job_queue - Rust
Description: This structure is backed by the `DependencyQueue` type and manages the actual compilation step of each package. Packages enqueue units of work and then later on the entire graph is processed and compiled.

Skip to main content

## DrainState

# Struct DrainState

Source

    struct DrainState<'gctx> {Show 20 fields
        total_units: usize,
        queue: DependencyQueue<Unit, Artifact, Job>,
        messages: Arc<Queue<Message>>,
        diag_dedupe: DiagDedupe<'gctx>,
        warning_count: HashMap<JobId, WarningCount>,
        active: HashMap<JobId, Unit>,
        compiled: HashSet<PackageId>,
        documented: HashSet<PackageId>,
        scraped: HashSet<PackageId>,
        counts: HashMap<PackageId, usize>,
        progress: Progress<'gctx>,
        next_id: u32,
        timings: Timings<'gctx>,
        unused_dep_state: UnusedDepState,
        index_to_unit: HashMap<UnitIndex, Unit>,
        tokens: Vec<Acquired>,
        pending_queue: Vec<(Unit, Job, usize)>,
        print: DiagnosticPrinter<'gctx>,
        finished: usize,
        per_package_future_incompat_reports: Vec<FutureIncompatReportPackage>,
    }

Expand description

This structure is backed by the `DependencyQueue` type and manages the actual compilation step of each package. Packages enqueue units of work and then later on the entire graph is processed and compiled.

It is created from `JobQueue` when we have fully assembled the crate graph (i.e., all package dependencies are known).

## Fields§

§`total_units: usize`§`queue: DependencyQueue<Unit, Artifact, Job>`§`messages: Arc<Queue<Message>>`§`diag_dedupe: DiagDedupe<'gctx>`

Diagnostic deduplication support.

§`warning_count: HashMap<JobId, WarningCount>`

Count of warnings, used to print a summary after the job succeeds

§`active: HashMap<JobId, Unit>`§`compiled: HashSet<PackageId>`§`documented: HashSet<PackageId>`§`scraped: HashSet<PackageId>`§`counts: HashMap<PackageId, usize>`§`progress: Progress<'gctx>`§`next_id: u32`§`timings: Timings<'gctx>`§`unused_dep_state: UnusedDepState`§`index_to_unit: HashMap<UnitIndex, Unit>`

Map from unit index to unit, for looking up dependency information.

§`tokens: Vec<Acquired>`

Tokens that are currently owned by this Cargo, and may be “associated” with a rustc process. They may also be unused, though if so will be dropped on the next loop iteration.

Note that the length of this may be zero, but we will still spawn work, as we share the implicit token given to this Cargo process with a single rustc process.

§`pending_queue: Vec<(Unit, Job, usize)>`

The list of jobs that we have not yet started executing, but have retrieved from the `queue`. We eagerly pull jobs off the main queue to allow us to request jobserver tokens pretty early.

§`print: DiagnosticPrinter<'gctx>`§`finished: usize`

How many jobs we’ve finished

§`per_package_future_incompat_reports: Vec<FutureIncompatReportPackage>`

## Implementations§

Source§

### impl<'gctx> DrainState<'gctx>

Source

#### fn spawn_work_if_possible<'s>( &mut self, build_runner: &mut BuildRunner<'_, '_>, jobserver_helper: &HelperThread, scope: &'s Scope<'s, '_>, ) -> CargoResult<()>

Source

#### fn has_extra_tokens(&self) -> bool

Source

#### fn handle_event( &mut self, build_runner: &mut BuildRunner<'_, '_>, event: Message, ) -> Result<(), ErrorToHandle>

Source

#### fn wait_for_events(&mut self) -> Vec<Message>

Source

#### fn drain_the_queue<'s>( self, build_runner: &mut BuildRunner<'_, '_>, scope: &'s Scope<'s, '_>, jobserver_helper: &HelperThread, ) -> (Result<(), Error>,)

This is the “main” loop, where Cargo does all work to run the compiler.

This returns a tuple of `Result` to prevent the use of `?` on `Result` types because it is important for the loop to carefully handle errors.

Source

#### fn handle_error( &mut self, shell: &mut Shell, err_state: &mut ErrorsDuringDrain, new_err: impl Into<ErrorToHandle>, )

Source

#### fn tick_progress(&mut self)

Source

#### fn name_for_progress(&self, unit: &Unit) -> String

Source

#### fn run<'s>( &mut self, unit: &Unit, job: Job, build_runner: &BuildRunner<'_, '_>, scope: &'s Scope<'s, '_>, )

Executes a job.

Fresh jobs block until finished (which should be very fast!), Dirty jobs will spawn a thread in the background and return immediately.

Source

#### fn emit_log_messages( &self, unit: &Unit, build_runner: &mut BuildRunner<'_, '_>, show_warnings: bool, ) -> CargoResult<()>

Source

#### fn bump_warning_count( &mut self, id: JobId, lint: bool, emitted: bool, fixable: bool, )

Source

#### fn report_warning_count( &mut self, runner: &mut BuildRunner<'_, '_>, unit: &Unit, count: &WarningCount, rustc_workspace_wrapper: &Option<PathBuf>, denied_warnings: bool, )

Displays a final report of the warnings emitted by a particular job.

Source

#### fn finish( &mut self, id: JobId, unit: &Unit, artifact: Artifact, build_runner: &mut BuildRunner<'_, '_>, ) -> CargoResult<()>

Source

#### fn note_working_on( &mut self, gctx: &GlobalContext, ws_root: &Path, unit: &Unit, fresh: &Freshness, ) -> CargoResult<()>

Source

#### fn back_compat_notice( &self, build_runner: &BuildRunner<'_, '_>, unit: &Unit, ) -> CargoResult<()>

## Auto Trait Implementations§

§

### impl<'gctx> !Freeze for DrainState<'gctx>

§

### impl<'gctx> !RefUnwindSafe for DrainState<'gctx>

§

### impl<'gctx> !Send for DrainState<'gctx>

§

### impl<'gctx> !Sync for DrainState<'gctx>

§

### impl<'gctx> Unpin for DrainState<'gctx>

§

### impl<'gctx> UnsafeUnpin for DrainState<'gctx>

§

### impl<'gctx> !UnwindSafe for DrainState<'gctx>

## Blanket Implementations§

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> From<T> for T

Source§

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

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

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

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

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

### impl<T> Pointable for T

§

#### const ALIGN: usize

The alignment of pointer.
§

#### type Init = T

The type for initializers.
§

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

Initializes a with the given initializer. Read more
§

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

Dereferences the given pointer. Read more
§

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

Mutably dereferences the given pointer. Read more
§

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

### impl<T> WithSubscriber for T

§

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

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