flag-spec.yaml

# NOTE: this file is used by the tool defined in
# ./internal/genflags/cmd/genflags/main.go which uses the
# `genflags.Spec` type that maps to this file structure.

flag_types:
  bool:
    struct_fields:
      - { name: Action, type: "func(*Context, bool) error" }
  float64:
    struct_fields:
      - { name: Action, type: "func(*Context, float64) error" }
  int64:
    struct_fields:
      - { name: Action, type: "func(*Context, int64) error" }
  int:
    struct_fields:
      - { name: Action, type: "func(*Context, int) error" }
  time.Duration:
    struct_fields:
      - { name: Action, type: "func(*Context, time.Duration) error" }
  uint64:
    struct_fields:
      - { name: Action, type: "func(*Context, uint64) error" }
  uint:
    struct_fields:
      - { name: Action, type: "func(*Context, uint) error" }
  string:
    struct_fields:
      - { name: TakesFile, type: bool }
      - { name: Action, type: "func(*Context, string) error" }
  Generic:
    struct_fields:
      - { name: TakesFile, type: bool }
      - { name: Action, type: "func(*Context, interface{}) error" }
  Path:
    struct_fields:
      - { name: TakesFile, type: bool }
      - { name: Action, type: "func(*Context, Path) error" }

  Float64Slice:
    value_pointer: true
    skip_interfaces:
      - fmt.Stringer
    struct_fields:
      - { name: Action, type: "func(*Context, []float64) error" }
  Int64Slice:
    value_pointer: true
    skip_interfaces:
      - fmt.Stringer
    struct_fields:
      - { name: Action, type: "func(*Context, []int64) error" }
  IntSlice:
    value_pointer: true
    skip_interfaces:
      - fmt.Stringer
    struct_fields:
      - { name: Action, type: "func(*Context, []int) error" }
  StringSlice:
    value_pointer: true
    skip_interfaces:
      - fmt.Stringer
    struct_fields:
      - { name: TakesFile, type: bool }
      - { name: Action, type: "func(*Context, []string) error" }
  Timestamp:
    value_pointer: true
    struct_fields:
      - { name: Layout, type: string }
      - { name: Action, type: "func(*Context, *time.Time) error" }

  # TODO: enable UintSlice
  # UintSlice: {}
  # TODO: enable Uint64Slice once #1334 lands
  # Uint64Slice: {}