Struct Options 

pub struct Options {

    pub to_update: Vec<(String, Option<Version>, Cow<'static, str>)>,
    pub all: bool,
    pub update: bool,
    pub install: bool,
    pub force: bool,
    pub downdate: bool,
    pub update_git: bool,
    pub quiet: bool,
    pub locked: bool,
    pub released_after: Option<DateTime<Utc>>,
    pub filter: Vec<PackageFilterElement>,
    pub cargo_dir: (PathBuf, PathBuf),
    pub temp_dir: PathBuf,
    pub cargo_install_args: Vec<OsString>,
    pub install_cargo: Option<OsString>,
    pub jobs: Option<NonZero<usize>>,
    pub recursive_jobs: Option<NonZero<usize>>,
    pub concurrent_cargos: Option<NonZero<usize>>,
}

Representation of the application’s all configurable values.

Fields

to_update: Vec<(String, Option<Version>, Cow<'static, str>)>

(Additional) packages to update. Default: []

all: bool

Whether to update all packages. Default: false

update: bool

Whether to update packages or just list them. Default: true

install: bool

Whether to allow for just installing packages. Default: false

force: bool

Update all packages. Default: false

downdate: bool

Downdate packages to match newest unyanked registry version.

update_git: bool

Update git packages too (it’s expensive). Default: false

quiet: bool

Don’t output messages and pass –quiet to cargo subprocesses. Default: false

locked: bool

Enforce packages’ embedded Cargo.lock. Exactly like CARGO_INSTALL_OPTS=--locked (or --enforce-lock per package) except doesn’t disable cargo-binstall. Default: false

released_after: Option<DateTime<Utc>>

Only install versions released after this time. Default: None

filter: Vec<PackageFilterElement>

Update all packages. Default: empty

cargo_dir: (PathBuf, PathBuf)

The cargo home directory; (original, canonicalised). Default: "$CARGO_INSTALL_ROOT", then "$CARGO_HOME", then "$HOME/.cargo"

temp_dir: PathBuf

The temporary directory to clone git repositories to. Default: "$TEMP/cargo-update"

cargo_install_args: Vec<OsString>

Arbitrary arguments to forward to cargo install, acquired from $CARGO_INSTALL_OPTS. Default: []

install_cargo: Option<OsString>

The cargo to run for installations. Default: None (use “cargo”)

jobs: Option<NonZero<usize>>

cargo install -j argument. Default: None

recursive_jobs: Option<NonZero<usize>>

Start jobserver to fill this many CPUs. Default: None

concurrent_cargos: Option<NonZero<usize>>

Additional limit of concurrent cargo installs. Default: None

Implementations

impl Options

pub fn parse() -> Options

Parse env-wide command-line arguments into an Options instance

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Eq for Options

impl Hash for Options

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Options

fn eq(&self, other: &Options) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Options