rsconstruct 0.9.153

Rust based fast build system
# Cargo Processor

## Purpose

Builds Rust projects using Cargo. Each crate target artifact (`<bin>`, `lib<name>.rlib`, `lib<name>.so`/`.dylib`, `lib<name>.a`) under `target/<profile>/` is planned in advance as its own cached product, while leaving Cargo's `target/<profile>/deps` incremental directory intact.

## How It Works

Discovers files named `Cargo.toml` in the project. For each `Cargo.toml` found,
the processor parses the manifest (and workspace members) to plan the output
artifacts for each configured profile, and runs `cargo build` (or a configured
command) at most once per `(Cargo.toml, profile)` when any planned product is dirty.

### Input Tracking

The cargo processor tracks **all `.rs` and `.toml` files, plus `Cargo.lock`,** in the Cargo.toml's
directory tree as inputs. This includes:

- `Cargo.toml` and `Cargo.lock`
- All Rust source files (`src/**/*.rs`)
- Test files, examples, benches
- Workspace member Cargo.toml files

When any tracked file changes, rsconstruct will re-run cargo.

### Workspaces

Cargo keeps one `target/` per workspace, in the workspace root's directory,
and the processor predicts artifacts where cargo writes them:

- **A workspace root** plans the artifacts of what a plain `cargo build` in
  its directory builds: every member of a virtual manifest (no `[package]`),
  only the root package of a manifest that has one, `default-members` when
  the manifest sets it (`.` standing for the root), and every member plus the
  root when `args` contains `--workspace` (or `--all`). `[workspace] members`
  globs (`crates/*`) are expanded and `exclude` is honoured; a member listed
  without a `Cargo.toml` is an error, as it is for cargo.
- **A member crate** discovered on its own (its root not scanned, or not
  building it) is built from its own directory, and its artifacts are planned
  under the *workspace root's* `target/<profile_dir>/`. The root is the one
  `[package] workspace` names, else the nearest ancestor `Cargo.toml` with a
  `[workspace]` that lists the crate (an `exclude`d crate is standalone). A
  workspace root above the project root is not seen.
- **A member whose root is scanned too** and whose root build includes it is
  left to the root: the root already plans its artifact, and a second cargo
  run from the member directory would race the first on the shared `target/`.

A `.cargo/config.toml` `build.target-dir` or `CARGO_TARGET_DIR` that moves
`target/` elsewhere is not read; the processor assumes cargo's default
layout. A `check`/`clippy` stamp (see below) stays under the crate's own
`target/<profile_dir>/`, so every crate of a workspace keeps a stamp of its own.

## Source Files

- Input: `Cargo.toml` plus all `.rs` and `.toml` files and `Cargo.lock` in the project tree
- Output: Planned crate target artifacts in `target/<profile_dir>/`

## Configuration

```toml
[processor.mass_generator.cargo]
cargo = "cargo"          # Cargo binary to use
command = "build"        # Cargo command (build, check, etc.)
args = []                # Extra arguments passed to cargo
profiles = ["dev", "release"]  # Cargo profiles to build
src_dirs = [""]          # Directory to scan ("" = project root)
src_extensions = ["Cargo.toml"]
dep_inputs = []          # Additional files that trigger rebuilds
```

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| `cargo` | string | `"cargo"` | Path or name of the cargo binary |
| `command` | string | `"build"` | Cargo subcommand to run |
| `args` | string[] | `[]` | Extra arguments passed to cargo |
| `profiles` | string[] | `["dev", "release"]` | Cargo profiles to build |
| `src_dirs` | string[] | `[]` | Directories to scan for Cargo.toml files (`[""]` for the whole project) |
| `src_extensions` | string[] | `["Cargo.toml"]` | File names to match |
| `src_exclude_dirs` | string[] | `[]` | Directory patterns to exclude |
| `src_exclude_paths` | string[] | `[]` | Paths (relative to project root) to exclude |
| `dep_inputs` | string[] | `[]` | Extra files whose changes trigger rebuilds |
| `required_tools` | string[] | `[]` | Extra tools the build needs on PATH beyond the built-in ones (e.g. what a wrapper script shells out to); checked before building and covered by `tool install` and version locking |

## Batch support

Runs once per `(Cargo.toml, profile)` when any planned artifact for that profile is dirty.

## Examples

### Basic Usage

```toml
[processor.mass_generator.cargo]
```

### Release Only

```toml
[processor.mass_generator.cargo]
profiles = ["release"]
```

### Dev Only

```toml
[processor.mass_generator.cargo]
profiles = ["dev"]
```

### Use cargo check Instead of build

```toml
[processor.mass_generator.cargo]
command = "check"
```

### Whole Workspace From a Root Package

```toml
[processor.mass_generator.cargo]
args = ["--workspace"]
```

## Notes

- Each top-level crate artifact in `target/<profile_dir>/` is cached as a blob in the object store, while `target/<profile_dir>/deps` stays untouched so Cargo retains its own incremental compilation state
- The `target/` directory is automatically excluded from input scanning
- For monorepos with multiple Rust projects, each Cargo.toml is built separately; the crates of one workspace share its `target/` (see [Workspaces]#workspaces)
- A command that produces no artifact (`check`, `clippy`) gets one stamp file, `target/<profile_dir>/.rsconstruct-<command>.stamp` under the crate's own directory, as its product

## Clean behavior

This processor is a Mass Generator — `rsconstruct clean outputs` removes each planned output file (`product.outputs`) and then sweeps any parent directories that are now empty. Pass `--no-empty-dirs` to keep them. See [Clean behavior](../../processors.md#clean-behavior) and [`rsconstruct clean`](../../commands.md#rsconstruct-clean).