Struct Packages 

pub struct Packages { /* private fields */ }

Implementations

impl Packages

pub fn new<P, N>( path: PathBuf, packages: &[P], root_package: Option<&P>, default_members: Vec<N>, ) -> Result<Self>

where P: Into<Package<ReadToml>> + Clone, N: ToString + Clone,

pub fn cargo_file_path(&self) -> &PathBuf

pub fn drop_root_package_name(&mut self)

pub fn workspace_default_members(&self) -> HashSet<&PackageName>

pub fn workspace_members(&self) -> HashSet<&PackageName>

pub fn set_root_package_name<'name>( &mut self, package_name: &'name PackageName, ) -> Option<&'name PackageName>

Trys to set root package name, returns None if package doesn’t exist or an invalid name is inputed.

Use Packages::try_set_root_package_name if you want to see the error.

pub fn try_set_root_package_name<'name>( &mut self, package_name: &'name PackageName, ) -> Result<&'name PackageName>

pub fn root_package_name_unchecked(&self) -> Option<&PackageName>

Only needs a &self as it returns what is set.

pub fn root_package_name(&mut self) -> Option<&PackageName>

Validated the set root name, uses Packages::drop_root_package_name if root_name is invalid.

pub fn get_root_package(&self) -> Option<&Package<ReadToml>>

Checks whether there is a root name and returns a ref to the root_package.

pub fn get_root_package_mut(&mut self) -> Option<&mut Package<ReadToml>>

Checks whether there is a root name and returns a mut ref to the root_package.

pub fn get_root_package_owned(&self) -> Option<Package<ReadToml>>

Checks whether there is a root name and returns an owned clone of the root_package.

pub fn get_package( &self, package_name: &PackageName, ) -> Option<&Package<ReadToml>>

Uses the HashMap::get and returns a ref to the Package if it exists.

pub fn get_package_mut( &mut self, package_name: &PackageName, ) -> Option<&mut Package<ReadToml>>

Uses the HashMap::get_mut and returns a mut ref to the Package if it exists.

pub fn get_package_owned( &self, package_name: &PackageName, ) -> Option<Package<ReadToml>>

Uses the HashMap::get followed by Option::cloned and returns Package if it exists.

pub fn packages(&self) -> &HashMap<PackageName, Package<ReadToml>>

pub fn package_set(&self) -> HashSet<&Package<ReadToml>>

pub fn set_cargo_file_path(&mut self, cargo_file: PathBuf)

pub fn root_version(&self) -> Result<Version, PackageError>

Determine what the root version is for the packages.

Order of checks:

• root version is set
• root package version
• workplace.package.version
• TODO: If all versions are the same use that version

pub fn workspace_package(&mut self) -> Option<&mut Package<ReadToml>>

impl Packages

pub fn display_tree(&self) -> String

Trait Implementations

impl AsRef<HashMap<PackageName, Package<ReadToml>>> for Packages

fn as_ref(&self) -> &HashMap<PackageName, Package<ReadToml>>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Packages

fn clone(&self) -> Packages

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Packages

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

Formats the value using the given formatter.

impl From<&Metadata> for Packages

fn from(metadata: &Metadata) -> Self

Converts to this type from the input type.

impl PartialEq for Packages

fn eq(&self, other: &Packages) -> 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 StructuralPartialEq for Packages