Struct IndexedWorkspace 

pub struct IndexedWorkspace {
    pub root: PathBuf,
    pub crates: Vec<IndexedCrate>,
}

The complete indexed workspace: every crate that was successfully indexed, plus workspace-level context needed by the generate stage.

Fields

root: PathBuf

Workspace root directory (parent of the top-level Cargo.toml).

crates: Vec<IndexedCrate>

Indexed crates in the order they were discovered by cargo metadata. Callers should not assume alphabetic or dependency order.

Implementations

impl IndexedWorkspace

pub fn build(workspace_root: &Path, config: &Config) -> Result<Self>

Enumerate the workspace at workspace_root, run rustdoc for every crate that is not excluded by config, and package the parsed results into an IndexedWorkspace.

Crates that expose neither a library nor a binary target are skipped silently (e.g. workspace-only virtual manifests). A single crate failure aborts the whole index pass; there is no partial result path at this stage.

Trait Implementations

impl Clone for IndexedWorkspace

fn clone(&self) -> IndexedWorkspace

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexedWorkspace

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

Formats the value using the given formatter.