guppy

Struct MetadataCommand

Source
pub struct MetadataCommand { /* private fields */ }
Expand description

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§

Source§

impl MetadataCommand

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

pub fn cargo_command(&self) -> Command

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

Source

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

Runs the configured cargo metadata and returns a deserialized CargoMetadata.

Source

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

Runs the configured cargo metadata and returns a parsed PackageGraph.

Trait Implementations§

Source§

impl Clone for MetadataCommand

Source§

fn clone(&self) -> MetadataCommand

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetadataCommand

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MetadataCommand

Source§

fn default() -> MetadataCommand

Returns the “default value” for a type. Read more
Source§

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

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl TryFrom<MetadataCommand> for PackageGraph

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

Source§

type Error = Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.