[−][src]Struct cargo::core::Workspace
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.
Implementations
impl<'cfg> Workspace<'cfg>
[src]
pub fn new(
manifest_path: &Path,
config: &'cfg Config
) -> CargoResult<Workspace<'cfg>>
[src]
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.
pub fn new_virtual(
root_path: PathBuf,
current_manifest: PathBuf,
manifest: VirtualManifest,
config: &'cfg Config
) -> CargoResult<Workspace<'cfg>>
[src]
root_path: PathBuf,
current_manifest: PathBuf,
manifest: VirtualManifest,
config: &'cfg Config
) -> CargoResult<Workspace<'cfg>>
pub fn ephemeral(
package: Package,
config: &'cfg Config,
target_dir: Option<Filesystem>,
require_optional_deps: bool
) -> CargoResult<Workspace<'cfg>>
[src]
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
.
pub fn current(&self) -> CargoResult<&Package>
[src]
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>
[src]
pub fn current_opt(&self) -> Option<&Package>
[src]
pub fn current_opt_mut(&mut self) -> Option<&mut Package>
[src]
pub fn is_virtual(&self) -> bool
[src]
pub fn config(&self) -> &'cfg Config
[src]
Returns the Config
this workspace is associated with.
pub fn profiles(&self) -> Option<&TomlProfiles>
[src]
pub fn root(&self) -> &Path
[src]
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.
pub fn root_manifest(&self) -> &Path
[src]
Returns the path of the Cargo.toml
which is the root of this
workspace.
pub fn target_dir(&self) -> Filesystem
[src]
pub fn root_replace(&self) -> &[(PackageIdSpec, Dependency)]
[src]
Returns the root [replace]
section of this workspace.
This may be from a virtual crate or an actual crate.
pub fn root_patch(&self) -> &HashMap<Url, Vec<Dependency>>
[src]
Returns the root [patch]
section of this workspace.
This may be from a virtual crate or an actual crate.
pub fn members<'a>(&'a self) -> Members<'a, 'cfg>ⓘ
[src]
Returns an iterator over all packages in this workspace
pub fn default_members<'a>(&'a self) -> Members<'a, 'cfg>ⓘ
[src]
Returns an iterator over default packages in this workspace
pub fn is_member(&self, pkg: &Package) -> bool
[src]
Returns true if the package is a member of the workspace.
pub fn is_ephemeral(&self) -> bool
[src]
pub fn require_optional_deps(&self) -> bool
[src]
pub fn set_require_optional_deps(
&mut self,
require_optional_deps: bool
) -> &mut Workspace<'cfg>
[src]
&mut self,
require_optional_deps: bool
) -> &mut Workspace<'cfg>
pub fn ignore_lock(&self) -> bool
[src]
pub fn set_ignore_lock(&mut self, ignore_lock: bool) -> &mut Workspace<'cfg>
[src]
pub fn custom_metadata(&self) -> Option<&Value>
[src]
pub fn load_workspace_config(
&mut self
) -> CargoResult<Option<WorkspaceRootConfig>>
[src]
&mut self
) -> CargoResult<Option<WorkspaceRootConfig>>
pub fn features(&self) -> &Features
[src]
pub fn resolve_behavior(&self) -> ResolveBehavior
[src]
pub fn allows_unstable_package_features(&self) -> bool
[src]
pub fn load(&self, manifest_path: &Path) -> CargoResult<Package>
[src]
pub fn preload(&self, registry: &mut PackageRegistry<'cfg>)
[src]
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<()>
[src]
pub fn set_target_dir(&mut self, target_dir: Filesystem)
[src]
pub fn members_with_features(
&self,
specs: &[PackageIdSpec],
requested_features: &RequestedFeatures
) -> CargoResult<Vec<(&Package, RequestedFeatures)>>
[src]
&self,
specs: &[PackageIdSpec],
requested_features: &RequestedFeatures
) -> CargoResult<Vec<(&Package, RequestedFeatures)>>
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.
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,