# Struct getopts::Matches [−] [src]

    pub struct Matches {
        pub free: Vec<String>,
        // some fields omitted
    }

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

The result of checking command line arguments. Contains a vector of matches and a vector of free strings.

## Fields

`free: Vec<String>`
🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Free string fragments

## Methods

###

`impl Matches`

[src]

####

`pub fn opt_defined(&self, nm: &str) -> bool`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns true if an option was defined

####

`pub fn opt_present(&self, nm: &str) -> bool`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns true if an option was matched.

####

`pub fn opt_count(&self, nm: &str) -> usize`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns the number of times an option was matched.

####

`pub fn opts_present(&self, names: &[String]) -> bool`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns true if any of several options were matched.

####

`pub fn opts_str(&self, names: &[String]) -> Option<String>`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns the string argument supplied to one of several matching options or `None`.

####

`pub fn opt_strs(&self, nm: &str) -> Vec<String>`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns a vector of the arguments provided to all matches of the given option.

Used when an option accepts multiple values.

####

`pub fn opt_str(&self, nm: &str) -> Option<String>`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns the string argument supplied to a matching option or `None`.

####

`pub fn opt_default(&self, nm: &str, def: &str) -> Option<String>`

[src]

🔬 This is a nightly-only experimental API. (`rustc_private`)

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via `Cargo.toml` instead?

Returns the matching string, a default, or `None`.

Returns `None` if the option was not present, `def` if the option was present but no argument was provided, and the argument if the option was present and an argument was provided.

## Trait Implementations

###

`impl Clone for Matches`

[src]

####

`fn clone(&self) -> Matches`

[src]

Returns a copy of the value. Read more

####

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

1.0.0
[src]

Performs copy-assignment from `source`. Read more

###

`impl PartialEq for Matches`

[src]

####

`fn eq(&self, __arg_0: &Matches) -> bool`

[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

####

`fn ne(&self, __arg_0: &Matches) -> bool`

[src]

This method tests for `!=`.

###

`impl Eq for Matches`

[src]

## Auto Trait Implementations

###

`impl Send for Matches`

###

`impl Sync for Matches`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)