Arg::requires_if

requires_if

since 0.1.0

Require another argument if this arg matches the ArgPredicate.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-if = { arg = "other", value = "my.cfg" } }
other = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-if:
      arg: other
      value: my.cfg
  other: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-if": {
        "arg": "other",
        "value": "my.cfg"
      }
    },
    "other": {}
  }
}

Input

prog --config some.cfg

Output

claptrap_config='some.cfg'

Example 2

Spec

TOML

name = "prog"
[args]
config = { long = "config", action = "set", requires-if = { arg = "other", value = "my.cfg" } }
other = {}

YAML

name: prog
args:
  config:
    long: config
    action: set
    requires-if:
      arg: other
      value: my.cfg
  other: {}

JSON

{
  "name": "prog",
  "args": {
    "config": {
      "long": "config",
      "action": "set",
      "requires-if": {
        "arg": "other",
        "value": "my.cfg"
      }
    },
    "other": {}
  }
}

Input

prog --config my.cfg

Output

error: the following required arguments were not provided:
  <other>

Usage: prog --config <config> <other>

For more information, try '--help'.