Struct MetadataCommand

pub struct MetadataCommand { /* private fields */ }

A builder for configuring cargo metadata invocations.

This is the most common entry point for constructing a PackageGraph.

Examples

Build a PackageGraph for the Cargo workspace in the current directory:

use guppy::MetadataCommand;
use guppy::graph::PackageGraph;

let mut cmd = MetadataCommand::new();
let package_graph = PackageGraph::from_command(&mut cmd);

Implementations

impl MetadataCommand

pub fn new() -> Self

Creates a default cargo metadata command builder.

By default, this will look for Cargo.toml in the ancestors of this process’s current directory.

pub fn cargo_path(&mut self, path: impl Into<PathBuf>) -> &mut Self

Sets the path to the cargo executable.

If unset, this will use the $CARGO environment variable, or else cargo from $PATH.

pub fn manifest_path(&mut self, path: impl Into<PathBuf>) -> &mut Self

Sets the path to Cargo.toml.

By default, this will look for Cargo.toml in the ancestors of the current directory. Note that this doesn’t need to be the root Cargo.toml in a workspace – any member of the workspace is fine.

pub fn current_dir(&mut self, path: impl Into<PathBuf>) -> &mut Self

Sets the current directory of the cargo metadata process.

By default, the current directory will be inherited from this process.

pub fn no_deps(&mut self) -> &mut Self

Output information only about the workspace and do not fetch dependencies.

For full functionality, cargo metadata should be run without --no-deps, so that guppy knows about third-party crates and dependency edges. However, guppy supports a “light” mode if --no-deps is run, in which case the following limitations will apply:

• dependency queries will not work
• there will be no information about non-workspace crates

Constructing a graph with this option can be several times faster than the default.

pub fn other_options( &mut self, options: impl IntoIterator<Item = impl Into<String>>, ) -> &mut Self

Arbitrary flags to pass to cargo metadata. These will be added to the end of the command invocation.

Note that guppy internally:

• uses --format-version 1 as its metadata format.
• passes in --all-features, so that guppy has a full view of the dependency graph.

Attempting to override either of those options may lead to unexpected results.

pub fn env( &mut self, key: impl Into<OsString>, val: impl Into<OsString>, ) -> &mut Self

Arbitrary environment variables to set when running cargo. These will be merged into the calling environment, overriding any which clash.

pub fn cargo_command(&self) -> Command

Builds a Command instance. This is the first part of calling exec.

pub fn exec(&self) -> Result<CargoMetadata, Error>

Runs the configured cargo metadata and returns a deserialized CargoMetadata.

pub fn build_graph(&self) -> Result<PackageGraph, Error>

Runs the configured cargo metadata and returns a parsed PackageGraph.

Trait Implementations

impl Clone for MetadataCommand

fn clone(&self) -> MetadataCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MetadataCommand

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

Formats the value using the given formatter.

impl Default for MetadataCommand

fn default() -> MetadataCommand

Returns the “default value” for a type.

impl<'a> TryFrom<&'a MetadataCommand> for PackageGraph

type Error = Error

The type returned in the event of a conversion error.

fn try_from(command: &'a MetadataCommand) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<MetadataCommand> for PackageGraph

Although consuming a MetadataCommand is not required for building a PackageGraph, this impl is provided for convenience.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(command: MetadataCommand) -> Result<Self, Self::Error>

Performs the conversion.