Arg::required_unless_present

required_unless_present

since 0.1.0

Set this arg as required as long as the specified argument is not present at runtime.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", required-unless-present = "dbg", action = "set" }
dbg = { long = "debug", action = "set-true" }

YAML

name: prog
args:
  cfg:
    long: config
    required-unless-present: dbg
    action: set
  dbg:
    long: debug
    action: set-true

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required-unless-present": "dbg",
      "action": "set"
    },
    "dbg": {
      "long": "debug",
      "action": "set-true"
    }
  }
}

Input

prog --debug

Output

claptrap_dbg='true'

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", required-unless-present = "dbg", action = "set" }
dbg = { long = "debug", action = "set-true" }

YAML

name: prog
args:
  cfg:
    long: config
    required-unless-present: dbg
    action: set
  dbg:
    long: debug
    action: set-true

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required-unless-present": "dbg",
      "action": "set"
    },
    "dbg": {
      "long": "debug",
      "action": "set-true"
    }
  }
}

Input

prog

Output

error: the following required arguments were not provided:
  --config <cfg>

Usage: prog --config <cfg>

For more information, try '--help'.