Struct CargoLayout 

pub struct CargoLayout { /* private fields */ }

The recognised Cargo packages in a scanned tree.

Implementations

impl CargoLayout

pub fn from_manifests(manifests: &[PathBuf]) -> Self

Build a layout from a set of Cargo.toml paths.

Manifests without a [package] section (pure [workspace] roots) or that fail to parse are skipped; a malformed manifest never aborts discovery.

pub fn packages(&self) -> Vec<PackageInfo>

The recognised packages, ordered by name.

pub fn classify(&self, absolute_path: &Path) -> (Option<String>, TargetKind)

Attribute an absolute file path to its package name and target kind.

Files outside every recognised package resolve to (None, TargetKind::Unknown).

pub fn crate_name(&self, absolute_path: &Path) -> Option<String>

The name a compiler knows absolute_path’s crate by, when the layout says which crate that is.

A compiler names a crate after the target, not the package: one package is a library, some binaries and a test crate per test file, and asking about a file under the wrong one gets an answer about somebody else’s code. Dashes become underscores because that mapping is the compiler’s — a crate name is an identifier and a package name need not be — rather than a guess about spelling.

None where the layout does not settle it: a file under tests/ that is not a target’s own entry point is a module of one of them, and which one is written in the code rather than in the manifest. Asking under a guessed crate would produce an answer about a crate the file is not in, which is worse than reporting that nobody asked.

Trait Implementations

impl Clone for CargoLayout

fn clone(&self) -> CargoLayout

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CargoLayout

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

Formats the value using the given formatter.

impl Default for CargoLayout

fn default() -> CargoLayout

Returns the “default value” for a type.