Struct guppy::graph::Workspace

pub struct Workspace<'g> { /* fields omitted */ }

Information about a workspace, parsed from metadata returned by cargo metadata.

For more about workspaces, see Cargo Workspaces in The Rust Programming Language.

Methods

impl<'g> Workspace<'g>

pub fn root(&self) -> &'g Path

Returns the workspace root.

pub fn members(
    &self
) -> impl Iterator<Item = (&'g Path, &'g PackageMetadata)> + ExactSizeIterator

Returns an iterator over workspace paths and package metadatas, sorted by the path they're in.

pub fn members_by_name(
    &self
) -> impl Iterator<Item = (&'g str, &'g PackageMetadata)> + ExactSizeIterator

Returns an iterator over workspace names and package metadatas, sorted by names.

pub fn member_ids(
    &self
) -> impl Iterator<Item = &'g PackageId> + ExactSizeIterator

Returns an iterator over package IDs for workspace members. The package IDs will be returned in the same order as members, sorted by the path they're in.

pub fn member_by_path(
    &self,
    path: impl AsRef<Path>
) -> Option<&'g PackageMetadata>

Maps the given path to the corresponding workspace member.

pub fn member_by_name(
    &self,
    name: impl AsRef<str>
) -> Option<&'g PackageMetadata>

Maps the given name to the corresponding workspace member.

Trait Implementations

impl<'g> Clone for Workspace<'g>

fn clone(&self) -> Workspace<'g>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'g> Debug for Workspace<'g>

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

Formats the value using the given formatter.