Struct cargo_options::Install

pub struct Install {

    pub common: CommonOptions,
    pub version: Option<String>,
    pub git: Option<String>,
    pub branch: Option<String>,
    pub tag: Option<String>,
    pub rev: Option<String>,
    pub path: Option<PathBuf>,
    pub list: bool,
    pub force: bool,
    pub no_track: bool,
    pub debug: bool,
    pub root: Option<PathBuf>,
    pub index: Option<String>,
    pub registry: Option<String>,
    pub bin: Vec<String>,
    pub bins: bool,
    pub example: Vec<String>,
    pub examples: bool,
    pub crates: Vec<String>,
}

Install a Rust binary. Default location is $HOME/.cargo/bin

Fields

common: CommonOptions

version: Option<String>

Specify a version to install

git: Option<String>

Git URL to install the specified crate from

branch: Option<String>

Branch to use when installing from git

tag: Option<String>

Tag to use when installing from git

rev: Option<String>

Specific commit to use when installing from git

path: Option<PathBuf>

Filesystem path to local crate to install

list: bool

list all installed packages and their versions

force: bool

Force overwriting existing crates or binaries

no_track: bool

Do not save tracking information

debug: bool

Build in debug mode (with the ‘dev’ profile) instead of release mode

root: Option<PathBuf>

Directory to install packages into

index: Option<String>

Registry index to install from

registry: Option<String>

Registry to use

bin: Vec<String>

Install only the specified binary

bins: bool

Install all binaries

example: Vec<String>

Install only the specified example

examples: bool

Install all examples

crates: Vec<String>

Implementations

impl Install

pub fn command(&self) -> Command

Build a cargo install command

Methods from Deref<Target = CommonOptions>

pub fn apply(&self, cmd: &mut Command)

Apply options to Command

Trait Implementations

impl Args for Install

fn group_id() -> Option<Id>

Report the ArgGroup::id for this set of arguments

fn augment_args<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self.

fn augment_args_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can update self.

impl Clone for Install

fn clone(&self) -> Install

Returns a copy of the value.

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

Performs copy-assignment from source.

impl CommandFactory for Install

fn command<'b>() -> Command

Build a Command that can instantiate Self.

fn command_for_update<'b>() -> Command

Build a Command that can update self.

impl Debug for Install

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

Formats the value using the given formatter.

impl Default for Install

fn default() -> Install

Returns the “default value” for a type.

impl Deref for Install

type Target = CommonOptions

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Install

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl FromArgMatches for Install

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut(
    __clap_arg_matches: &mut ArgMatches
) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches(
    &mut self,
    __clap_arg_matches: &ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut(
    &mut self,
    __clap_arg_matches: &mut ArgMatches
) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Parser for Install

fn parse() -> Self

Parse from std::env::args_os(), exit on error

fn try_parse() -> Result<Self, Error<RichFormatter>>

Parse from std::env::args_os(), return Err on error.

fn parse_from<I, T>(itr: I) -> Selfwhere
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, exit on error

fn try_parse_from<I, T>(itr: I) -> Result<Self, Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Parse from iterator, return Err on error.

fn update_from<I, T>(&mut self, itr: I)where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, exit on error

fn try_update_from<I, T>(&mut self, itr: I) -> Result<(), Error<RichFormatter>>where
    I: IntoIterator<Item = T>,
    T: Into<OsString> + Clone,

Update from iterator, return Err on error.