Arg::required_if_eq

required_if_eq

since 0.1.0

This argument is required only if the specified arg is present at runtime and its value equals val.

Examples

Example 1

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq = { arg = "other", value = "special" } }
other = { long = "other", action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq:
      arg: other
      value: special
  other:
    long: other
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq": {
        "arg": "other",
        "value": "special"
      }
    },
    "other": {
      "long": "other",
      "action": "set"
    }
  }
}

Input

prog --other not-special

Output

claptrap_other='not-special'

Example 2

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq = { arg = "other", value = "special" } }
other = { long = "other", action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq:
      arg: other
      value: special
  other:
    long: other
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq": {
        "arg": "other",
        "value": "special"
      }
    },
    "other": {
      "long": "other",
      "action": "set"
    }
  }
}

Input

prog --other special

Output

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

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

For more information, try '--help'.

Example 3

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq = { arg = "other", value = "special" } }
other = { long = "other", action = "set", ignore-case = true }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq:
      arg: other
      value: special
  other:
    long: other
    action: set
    ignore-case: true

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq": {
        "arg": "other",
        "value": "special"
      }
    },
    "other": {
      "long": "other",
      "action": "set",
      "ignore-case": true
    }
  }
}

Input

prog --other SPECIAL

Output

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

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

For more information, try '--help'.

Example 4

Spec

TOML

name = "prog"
[args]
cfg = { long = "config", action = "set", required-if-eq = { arg = "other", value = "special" } }
other = { long = "other", action = "set" }

YAML

name: prog
args:
  cfg:
    long: config
    action: set
    required-if-eq:
      arg: other
      value: special
  other:
    long: other
    action: set

JSON

{
  "name": "prog",
  "args": {
    "cfg": {
      "long": "config",
      "action": "set",
      "required-if-eq": {
        "arg": "other",
        "value": "special"
      }
    },
    "other": {
      "long": "other",
      "action": "set"
    }
  }
}

Input

prog --other SPECIAL

Output

claptrap_other='SPECIAL'