Arg::required_if_eq_any

required_if_eq_any

since 0.1.0

Specify this argument is required based on multiple conditions.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq-any = [{ arg = "extra", value = "val" }, { arg = "option", value = "spec" }] }
extra = { long = "extra", action = "set" }
option = { long = "option", action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq-any:
    - arg: extra
      value: val
    - arg: option
      value: spec
  extra:
    long: extra
    action: set
  option:
    long: option
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq-any": [
        {
          "arg": "extra",
          "value": "val"
        },
        {
          "arg": "option",
          "value": "spec"
        }
      ]
    },
    "extra": {
      "long": "extra",
      "action": "set"
    },
    "option": {
      "long": "option",
      "action": "set"
    }
  }
}

Input

prog --option other

Output

claptrap_option='other'

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq-any = [{ arg = "extra", value = "val" }, { arg = "option", value = "spec" }] }
extra = { long = "extra", action = "set" }
option = { long = "option", action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq-any:
    - arg: extra
      value: val
    - arg: option
      value: spec
  extra:
    long: extra
    action: set
  option:
    long: option
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq-any": [
        {
          "arg": "extra",
          "value": "val"
        },
        {
          "arg": "option",
          "value": "spec"
        }
      ]
    },
    "extra": {
      "long": "extra",
      "action": "set"
    },
    "option": {
      "long": "option",
      "action": "set"
    }
  }
}

Input

prog --option spec

Output

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

Usage: prog --option <option> --config <cfg>

For more information, try '--help'.