Struct MetadataCommand 

pub struct MetadataCommand { /* private fields */ }

A builder for scarb metadata command invocation.

In detail, this will always execute scarb --json metadata --format-version N, where N matches metadata version understandable by this crate version.

Implementations

impl MetadataCommand

pub fn new() -> Self

Creates a default scarb metadata command, which will look for scarb in $PATH and for Scarb.toml in the current directory or its ancestors.

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

Path to scarb executable.

If not set, this will use the $SCARB environment variable, and if that is not set, it will simply be scarb and the system will look it up in $PATH.

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

Path to Scarb.toml.

If not set, this will look for Scarb.toml in the current directory or its ancestors.

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

Current directory of the scarb metadata process.

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

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

pub fn profile(&mut self, profile: impl AsRef<OsStr>) -> &mut Self

Defines profile to use for scarb metadata command.

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

Defines profile to use for scarb metadata command as “dev”.

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

Defines profile to use for scarb metadata command as “release”.

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

Inserts or updates an environment variable mapping.

pub fn envs<I, K, V>(&mut self, vars: I) -> &mut Self

where I: IntoIterator<Item = (K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>,

Adds or updates multiple environment variable mappings.

pub fn env_remove(&mut self, key: impl AsRef<OsStr>) -> &mut Self

Removes an environment variable mapping.

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

Clears the entire environment map for the child process.

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

Inherit standard error, i.e. show Scarb errors in this process’s standard error.

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

Inherit standard output, i.e. show Scarb output in this process’s standard output.

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

Set output format to JSON.

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

Runs configured scarb 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

Formats the value using the given formatter.

impl Default for MetadataCommand

fn default() -> MetadataCommand

Returns the “default value” for a type.