Struct CargoWorkspace

pub struct CargoWorkspace { /* private fields */ }

CargoWorkspace represents the logical structure of, well, a Cargo workspace. It pretty closely mirrors cargo metadata output.

Note that internally, rust-analyzer uses a different structure: CrateGraph. CrateGraph is lower-level: it knows only about the crates, while this knows about Packages & Targets: purely cargo-related concepts.

We use absolute paths here, cargo metadata guarantees to always produce abs paths.

Implementations

impl CargoWorkspace

pub fn fetch_metadata( cargo_toml: &ManifestPath, current_dir: &AbsPath, config: &CargoMetadataConfig, sysroot: &Sysroot, no_deps: bool, locked: bool, progress: &dyn Fn(String), ) -> Result<(Metadata, Option<Error>)>

Fetches the metadata for the given cargo_toml manifest. A successful result may contain another metadata error if the initial fetching failed but the --no-deps retry succeeded.

The sysroot is used to set the RUSTUP_TOOLCHAIN env var when invoking cargo to ensure that the rustup proxy uses the correct toolchain.

pub fn new( meta: Metadata, ws_manifest_path: ManifestPath, cargo_config_env: Env, is_sysroot: bool, ) -> CargoWorkspace

pub fn packages(&self) -> impl ExactSizeIterator<Item = Package> + '_

pub fn target_by_root(&self, root: &AbsPath) -> Option<Target>

pub fn workspace_root(&self) -> &AbsPath

pub fn manifest_path(&self) -> &ManifestPath

pub fn target_directory(&self) -> &AbsPath

pub fn package_flag(&self, package: &PackageData) -> String

pub fn parent_manifests( &self, manifest_path: &ManifestPath, ) -> Option<Vec<ManifestPath>>

pub fn workspace_features(&self) -> FxHashSet<String>

Returns the union of the features of all member crates in this workspace.

pub fn is_virtual_workspace(&self) -> bool

pub fn env(&self) -> &Env

pub fn is_sysroot(&self) -> bool

Trait Implementations

impl Clone for CargoWorkspace

fn clone(&self) -> CargoWorkspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CargoWorkspace

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

Formats the value using the given formatter.

impl Index<Idx<PackageData>> for CargoWorkspace

type Output = PackageData

The returned type after indexing.

fn index(&self, index: Package) -> &PackageData

Performs the indexing (container[index]) operation.

impl Index<Idx<TargetData>> for CargoWorkspace

type Output = TargetData

The returned type after indexing.

fn index(&self, index: Target) -> &TargetData

Performs the indexing (container[index]) operation.

impl PartialEq for CargoWorkspace

fn eq(&self, other: &CargoWorkspace) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CargoWorkspace

impl StructuralPartialEq for CargoWorkspace