pub struct Workspace<'cfg> {Show 14 fields
config: &'cfg Config,
current_manifest: PathBuf,
packages: Packages<'cfg>,
root_manifest: Option<PathBuf>,
target_dir: Option<Filesystem>,
members: Vec<PathBuf>,
member_ids: HashSet<PackageId>,
default_members: Vec<PathBuf>,
is_ephemeral: bool,
require_optional_deps: bool,
loaded_packages: RefCell<HashMap<PathBuf, Package>>,
ignore_lock: bool,
resolve_behavior: ResolveBehavior,
custom_metadata: Option<Value>,
}
Expand description
The core abstraction in Cargo for working with a workspace of crates.
A workspace is often created very early on and then threaded through all other functions. It’s typically through this object that the current package is loaded and/or learned about.
Fields§
§config: &'cfg Config
§current_manifest: PathBuf
§packages: Packages<'cfg>
§root_manifest: Option<PathBuf>
§target_dir: Option<Filesystem>
§members: Vec<PathBuf>
§member_ids: HashSet<PackageId>
§default_members: Vec<PathBuf>
§is_ephemeral: bool
§require_optional_deps: bool
§loaded_packages: RefCell<HashMap<PathBuf, Package>>
§ignore_lock: bool
§resolve_behavior: ResolveBehavior
The resolver behavior specified with the resolver
field.
custom_metadata: Option<Value>
Workspace-level custom metadata
Implementations§
source§impl<'cfg> Workspace<'cfg>
impl<'cfg> Workspace<'cfg>
sourcepub fn new(
manifest_path: &Path,
config: &'cfg Config
) -> CargoResult<Workspace<'cfg>>
pub fn new( manifest_path: &Path, config: &'cfg Config ) -> CargoResult<Workspace<'cfg>>
Creates a new workspace given the target manifest pointed to by
manifest_path
.
This function will construct the entire workspace by determining the
root and all member packages. It will then validate the workspace
before returning it, so Ok
is only returned for valid workspaces.
fn new_default( current_manifest: PathBuf, config: &'cfg Config ) -> Workspace<'cfg>
pub fn new_virtual( root_path: PathBuf, current_manifest: PathBuf, manifest: VirtualManifest, config: &'cfg Config ) -> CargoResult<Workspace<'cfg>>
sourcepub fn ephemeral(
package: Package,
config: &'cfg Config,
target_dir: Option<Filesystem>,
require_optional_deps: bool
) -> CargoResult<Workspace<'cfg>>
pub fn ephemeral( package: Package, config: &'cfg Config, target_dir: Option<Filesystem>, require_optional_deps: bool ) -> CargoResult<Workspace<'cfg>>
Creates a “temporary workspace” from one package which only contains that package.
This constructor will not touch the filesystem and only creates an in-memory workspace. That is, all configuration is ignored, it’s just intended for that one package.
This is currently only used in niche situations like cargo install
or
cargo package
.
fn set_resolve_behavior(&mut self)
sourcepub fn current(&self) -> CargoResult<&Package>
pub fn current(&self) -> CargoResult<&Package>
Returns the current package of this workspace.
Note that this can return an error if it the current manifest is actually a “virtual Cargo.toml”, in which case an error is returned indicating that something else should be passed.
pub fn current_mut(&mut self) -> CargoResult<&mut Package>
pub fn current_opt(&self) -> Option<&Package>
pub fn current_opt_mut(&mut self) -> Option<&mut Package>
pub fn is_virtual(&self) -> bool
pub fn profiles(&self) -> Option<&TomlProfiles>
sourcepub fn root(&self) -> &Path
pub fn root(&self) -> &Path
Returns the root path of this workspace.
That is, this returns the path of the directory containing the
Cargo.toml
which is the root of this workspace.
sourcepub fn root_manifest(&self) -> &Path
pub fn root_manifest(&self) -> &Path
Returns the path of the Cargo.toml
which is the root of this
workspace.
sourcepub fn root_maybe(&self) -> &MaybePackage
pub fn root_maybe(&self) -> &MaybePackage
Returns the root Package or VirtualManifest.
pub fn target_dir(&self) -> Filesystem
fn default_target_dir(&self) -> Filesystem
sourcepub fn root_replace(&self) -> &[(PackageIdSpec, Dependency)]
pub fn root_replace(&self) -> &[(PackageIdSpec, Dependency)]
Returns the root [replace]
section of this workspace.
This may be from a virtual crate or an actual crate.
fn config_patch(&self) -> CargoResult<HashMap<Url, Vec<Dependency>>>
sourcepub fn root_patch(&self) -> CargoResult<HashMap<Url, Vec<Dependency>>>
pub fn root_patch(&self) -> CargoResult<HashMap<Url, Vec<Dependency>>>
Returns the root [patch]
section of this workspace.
This may be from a virtual crate or an actual crate.
sourcepub fn members(&self) -> impl Iterator<Item = &Package>
pub fn members(&self) -> impl Iterator<Item = &Package>
Returns an iterator over all packages in this workspace
sourcepub fn members_mut(&mut self) -> impl Iterator<Item = &mut Package>
pub fn members_mut(&mut self) -> impl Iterator<Item = &mut Package>
Returns a mutable iterator over all packages in this workspace
sourcepub fn default_members<'a>(&'a self) -> impl Iterator<Item = &Package>
pub fn default_members<'a>(&'a self) -> impl Iterator<Item = &Package>
Returns an iterator over default packages in this workspace
sourcepub fn default_members_mut(&mut self) -> impl Iterator<Item = &mut Package>
pub fn default_members_mut(&mut self) -> impl Iterator<Item = &mut Package>
Returns an iterator over default packages in this workspace
sourcepub fn is_member(&self, pkg: &Package) -> bool
pub fn is_member(&self, pkg: &Package) -> bool
Returns true if the package is a member of the workspace.
pub fn is_ephemeral(&self) -> bool
pub fn require_optional_deps(&self) -> bool
pub fn set_require_optional_deps( &mut self, require_optional_deps: bool ) -> &mut Workspace<'cfg>
pub fn ignore_lock(&self) -> bool
pub fn set_ignore_lock(&mut self, ignore_lock: bool) -> &mut Workspace<'cfg>
sourcepub fn rust_version(&self) -> Option<&RustVersion>
pub fn rust_version(&self) -> Option<&RustVersion>
Get the lowest-common denominator package.rust-version
within the workspace, if specified
anywhere
pub fn custom_metadata(&self) -> Option<&Value>
pub fn load_workspace_config( &mut self ) -> CargoResult<Option<WorkspaceRootConfig>>
sourcefn find_root(&mut self, manifest_path: &Path) -> CargoResult<Option<PathBuf>>
fn find_root(&mut self, manifest_path: &Path) -> CargoResult<Option<PathBuf>>
Finds the root of a workspace for the crate whose manifest is located
at manifest_path
.
This will parse the Cargo.toml
at manifest_path
and then interpret
the workspace configuration, optionally walking up the filesystem
looking for other workspace roots.
Returns an error if manifest_path
isn’t actually a valid manifest or
if some other transient error happens.
sourcefn find_members(&mut self) -> CargoResult<()>
fn find_members(&mut self) -> CargoResult<()>
After the root of a workspace has been located, probes for all members of a workspace.
If the workspace.members
configuration is present, then this just
verifies that those are all valid packages to point to. Otherwise, this
will transitively follow all path
dependencies looking for members of
the workspace.
fn find_path_deps( &mut self, manifest_path: &Path, root_manifest: &Path, is_path_dep: bool ) -> CargoResult<()>
sourcepub fn unstable_features(&self) -> &Features
pub fn unstable_features(&self) -> &Features
Returns the unstable nightly-only features enabled via cargo-features
in the manifest.
pub fn resolve_behavior(&self) -> ResolveBehavior
sourcepub fn allows_new_cli_feature_behavior(&self) -> bool
pub fn allows_new_cli_feature_behavior(&self) -> bool
Returns true
if this workspace uses the new CLI features behavior.
The old behavior only allowed choosing the features from the package in the current directory, regardless of which packages were chosen with the -p flags. The new behavior allows selecting features from the packages chosen on the command line (with -p or –workspace flags), ignoring whatever is in the current directory.
sourcefn validate(&mut self) -> CargoResult<()>
fn validate(&mut self) -> CargoResult<()>
Validates a workspace, ensuring that a number of invariants are upheld:
- A workspace only has one root.
- All workspace members agree on this one root as the root.
- The current crate is a member of this workspace.
fn validate_unique_names(&self) -> CargoResult<()>
fn validate_workspace_roots(&self) -> CargoResult<()>
fn validate_members(&mut self) -> CargoResult<()>
fn error_if_manifest_not_in_members(&mut self) -> CargoResult<()>
fn validate_manifest(&mut self) -> CargoResult<()>
pub fn load(&self, manifest_path: &Path) -> CargoResult<Package>
sourcepub fn preload(&self, registry: &mut PackageRegistry<'cfg>)
pub fn preload(&self, registry: &mut PackageRegistry<'cfg>)
Preload the provided registry with already loaded packages.
A workspace may load packages during construction/parsing/early phases for various operations, and this preload step avoids doubly-loading and parsing crates on the filesystem by inserting them all into the registry with their in-memory formats.
pub fn emit_warnings(&self) -> CargoResult<()>
pub fn set_target_dir(&mut self, target_dir: Filesystem)
sourcepub fn members_with_features(
&self,
specs: &[PackageIdSpec],
cli_features: &CliFeatures
) -> CargoResult<Vec<(&Package, CliFeatures)>>
pub fn members_with_features( &self, specs: &[PackageIdSpec], cli_features: &CliFeatures ) -> CargoResult<Vec<(&Package, CliFeatures)>>
Returns a Vec of (&Package, RequestedFeatures)
tuples that
represent the workspace members that were requested on the command-line.
specs
may be empty, which indicates it should return all workspace
members. In this case, requested_features.all_features
must be
true
. This is used for generating Cargo.lock
, which must include
all members with all features enabled.
sourcefn collect_matching_features(
member: &Package,
cli_features: &CliFeatures,
found_features: &mut BTreeSet<FeatureValue>
) -> CliFeatures
fn collect_matching_features( member: &Package, cli_features: &CliFeatures, found_features: &mut BTreeSet<FeatureValue> ) -> CliFeatures
Returns the requested features for the given member. This filters out any named features that the member does not have.
fn report_unknown_features_error( &self, specs: &[PackageIdSpec], cli_features: &CliFeatures, found_features: &BTreeSet<FeatureValue> ) -> CargoResult<()>
sourcefn members_with_features_new(
&self,
specs: &[PackageIdSpec],
cli_features: &CliFeatures
) -> CargoResult<Vec<(&Package, CliFeatures)>>
fn members_with_features_new( &self, specs: &[PackageIdSpec], cli_features: &CliFeatures ) -> CargoResult<Vec<(&Package, CliFeatures)>>
New command-line feature selection behavior with resolver = “2” or the
root of a virtual workspace. See allows_new_cli_feature_behavior
.
sourcefn members_with_features_old(
&self,
specs: &[PackageIdSpec],
cli_features: &CliFeatures
) -> Vec<(&Package, CliFeatures)>
fn members_with_features_old( &self, specs: &[PackageIdSpec], cli_features: &CliFeatures ) -> Vec<(&Package, CliFeatures)>
This is the “old” behavior for command-line feature selection.
See allows_new_cli_feature_behavior
.
sourcepub fn unit_needs_doc_scrape(&self, unit: &Unit) -> bool
pub fn unit_needs_doc_scrape(&self, unit: &Unit) -> bool
Returns true if unit
should depend on the output of Docscrape units.
Trait Implementations§
Auto Trait Implementations§
impl<'cfg> !RefUnwindSafe for Workspace<'cfg>
impl<'cfg> !Send for Workspace<'cfg>
impl<'cfg> !Sync for Workspace<'cfg>
impl<'cfg> Unpin for Workspace<'cfg>
impl<'cfg> !UnwindSafe for Workspace<'cfg>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> WithSubscriber for T
impl<T> WithSubscriber for T
source§fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,
source§fn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
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: 328 bytes