flags

Documentation

Overview

Package flags adds more types of flags which satisfy the flag.Value interface.

Index

• type IntRange
  • func (ir *IntRange) Set(v string) error
  • func (ir *IntRange) String() string

Examples

• IntRange

Types

type IntRange

type IntRange struct {
	Value, Min, Max int
}

IntRange is used to specify an *inclusive* range for the std "flag" package. The result is stored in Value.

Example

package main

import (
	"flag"
	"fmt"

	"github.com/aod/elver/flags"
)

func main() {
	fs := flag.NewFlagSet("example usage of IntRange", flag.ContinueOnError)

	ir := flags.IntRange{Min: 0, Max: 10}
	fs.Var(&ir, "num", "select a number between 1 to 10")

	fs.Parse([]string{"-num", "6"})

	fmt.Println(ir.Value)
}

Output:

6

func (*IntRange) Set

func (ir *IntRange) Set(v string) error

Set satasfies part of the flag.Value interface. It returns an error if Atoi of v failes or num resides outside of the inclusive int range. Otherwise the result is stored in Value.

func (*IntRange) String

func (ir *IntRange) String() string