Struct MetadataCommand

pub struct MetadataCommand { /* private fields */ }

A builder for configurating cargo metadata invocation.

Implementations

impl MetadataCommand

pub fn new() -> MetadataCommand

Creates a default cargo metadata command, which will look for Cargo.toml in the ancestors of the current directory.

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

Path to cargo executable. If not set, this will use the the $CARGO environment variable, and if that is not set, will simply be cargo.

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

Path to Cargo.toml

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

Current directory of the cargo metadata process.

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

Output information only about workspace members and don’t fetch dependencies.

pub fn features(&mut self, features: CargoOpt) -> &mut MetadataCommand

Which features to include.

Call this multiple times to specify advanced feature configurations:

MetadataCommand::new()
    .features(CargoOpt::NoDefaultFeatures)
    .features(CargoOpt::SomeFeatures(vec!["feat1".into(), "feat2".into()]))
    .features(CargoOpt::SomeFeatures(vec!["feat3".into()]))
    // ...

Panics

cargo metadata rejects multiple --no-default-features flags. Similarly, the features() method panics when specifying multiple CargoOpt::NoDefaultFeatures:

MetadataCommand::new()
    .features(CargoOpt::NoDefaultFeatures)
    .features(CargoOpt::NoDefaultFeatures) // <-- panic!
    // ...

The method also panics for multiple CargoOpt::AllFeatures arguments:

MetadataCommand::new()
    .features(CargoOpt::AllFeatures)
    .features(CargoOpt::AllFeatures) // <-- panic!
    // ...

pub fn other_options( &mut self, options: impl Into<Vec<String>>, ) -> &mut MetadataCommand

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

pub fn env<K, V>(&mut self, key: K, val: V) -> &mut MetadataCommand

where K: Into<OsString>, V: Into<OsString>,

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

Some examples of when you may want to use this:

1. Setting cargo config values without needing a .cargo/config.toml file, e.g. to set CARGO_NET_GIT_FETCH_WITH_CLI=true
2. To specify a custom path to RUSTC if your rust toolchain components aren’t laid out in the way cargo expects by default.

MetadataCommand::new()
    .env("CARGO_NET_GIT_FETCH_WITH_CLI", "true")
    .env("RUSTC", "/path/to/rustc")
    // ...

pub fn verbose(&mut self, verbose: bool) -> &mut MetadataCommand

Set whether to show stderr

pub fn cargo_command(&self) -> Command

Builds a command for cargo metadata. This is the first part of the work of exec.

pub fn parse<T>(data: T) -> Result<Metadata, Error>

where T: AsRef<str>,

Parses cargo metadata output. data must have been produced by a command built with cargo_command.

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

Runs configured cargo metadata and returns parsed Metadata.

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<(), Error>

Formats the value using the given formatter.

impl Default for MetadataCommand

fn default() -> MetadataCommand

Returns the “default value” for a type.