Arg::required_unless_present_any

required_unless_present_any

since 0.1.0

Sets this arg as required unless any of the specified arguments are present at runtime.

Examples

Example 1

Spec

TOML

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

YAML

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

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required-unless-present-any": [
        "dbg",
        "infile"
      ],
      "action": "set"
    },
    "dbg": {
      "long": "debug",
      "action": "set-true"
    },
    "infile": {
      "short": "i",
      "action": "set"
    }
  }
}

Input

prog --debug

Output

claptrap_dbg='true'

Example 2

Spec

TOML

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

YAML

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

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "required-unless-present-any": [
        "dbg",
        "infile"
      ],
      "action": "set"
    },
    "dbg": {
      "long": "debug",
      "action": "set-true"
    },
    "infile": {
      "short": "i",
      "action": "set"
    }
  }
}

Input

prog

Output

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

Usage: prog --config <cfg>

For more information, try '--help'.