luci: go.chromium.org/luci/common/flag Index | Examples | Files | Directories

package flag

import "go.chromium.org/luci/common/flag"

Package flag provides the utilities for implementing command line flags.

Index

Examples

Package Files

boolslice.go choice.go commalist.go doc.go fieldslice.go int32.go int64slice.go jsonmap.go meta.go protomsgsliceflag.go reltime.go stringslice.go strmap.go strpairs.go time.go timelayout.go

func BoolSlice Uses

❖
func BoolSlice(b *[]bool) flag.Getter

BoolSlice returns a flag.Getter which reads flags into the given []bool pointer.

func CommaList Uses

❖
func CommaList(s *[]string) flag.Getter

CommaList returns a flag.Getter for parsing a comma separated flag argument into a string slice.

func Date Uses

❖
func Date(t *time.Time) flag.Getter

Date returns a flag.Getter which parses the flag value as a UTC date. The string must be a time with layout "2006-01-24".

func FieldSlice Uses

❖
func FieldSlice(f *[]googleapi.Field) flag.Getter

FieldSlice returns a flag.Getter which reads flags into the given []googleapi.Field pointer.

func GRPCMetadata Uses

❖
func GRPCMetadata(md metadata.MD) flag.Getter

GRPCMetadata returns a flag.Getter for parsing gRPC metadata from a a set of colon-separated strings. Example: -f a:1 -f a:2 -f b:3 Panics if md is nil.

func Int32 Uses

❖
func Int32(i *int32) flag.Getter

Int32 returns a flag.Getter which reads flags into the given int32 pointer.

func Int64Slice Uses

❖
func Int64Slice(i *[]int64) flag.Getter

Int64Slice returns a flag.Getter which reads flags into the given []int64 pointer.

func JSONMap Uses

❖
func JSONMap(m *map[string]string) flag.Value

JSONMap returns a flag.Value that can be passed to flag.Var to parse a JSON string into a map.

func MessageSliceFlag Uses

❖
func MessageSliceFlag(msgSlicePtr interface{}) flag.Getter

MessageSliceFlag returns a new flag for a slice of pointer to concrete proto message struct which implements the proto.Message interface. Expect input to be of type *[]*B where B is concrete struct of proto message like pb.Build. A flag value must be a JSON string of the provided concrete proto message.

Example

Code: 

var builds []*pb.Build
fs := flag.NewFlagSet("test", flag.ContinueOnError)
flag := MessageSliceFlag(&builds)
fs.Var(flag, "build", "Test Proto Message")
fs.Parse([]string{"-build",
    "{\"id\": 111111, \"status\": \"SUCCESS\"}"})
marshaler := &jsonpb.Marshaler{Indent: "  "}
jsonMsg, _ := marshaler.MarshalToString(builds[0])
fmt.Println(jsonMsg)

Output:

{
  "id": "111111",
  "status": "SUCCESS"
}

func StringMap Uses

❖
func StringMap(m map[string]string) flag.Getter

StringMap returns a flag.Getter for parsing map[string]string from a a set of colon-separated strings. Example: 

-f a:1 -f b:3

The flag.Getter.Set implementation returns an error if the key is already in the map. Panics if m is nil.

func StringPairs Uses

❖
func StringPairs(m strpair.Map) flag.Getter

StringPairs returns a flag.Getter for parsing strpair.Map from a a set of colon-separated strings. Example: 

-f a:1 -f a:2 -f b:3

Panics if m is nil.

func StringSlice Uses

❖
func StringSlice(s *[]string) flag.Getter

StringSlice returns a flag.Getter which reads flags into the given []string pointer.

func Time Uses

❖
func Time(t *time.Time) flag.Getter

Time returns a flag.Getter which parses a string into a time.Time pointer.

The timestamp to parse must be formatted as stiptime: https://chromium.googlesource.com/infra/infra/infra_libs/+/b2e2c9948c327b88b138d8bd60ec4bb3a957be78/time_functions/README.md

Caveat: Leap seconds are not supported due to a limitation in go's time library: https://github.com/golang/go/issues/15247

func TimeLayout Uses

❖
func TimeLayout(t *time.Time, layout string) flag.Getter

TimeLayout returns a flag.Getter which parses the flag value as a UTC time, based on the given layout.

type Choice Uses

❖
type Choice struct {
    // contains filtered or unexported fields
}

Choice is an implementation of flag.Value for parsing a multiple-choice string.

func NewChoice Uses

❖
func NewChoice(output *string, choices ...string) Choice

NewChoice creates a Choice value

func (Choice) Set Uses

❖
func (f Choice) Set(s string) error

Set implements the flag.Value interface.

func (Choice) String Uses

❖
func (f Choice) String() string

String implements the flag.Value interface.

type RelativeTime Uses

❖
type RelativeTime struct {
    T *time.Time
    // contains filtered or unexported fields
}

RelativeTime is an implementation of flag.Value for parsing a time by a relative day offset.

func (RelativeTime) Set Uses

❖
func (f RelativeTime) Set(s string) error

Set implements the flag.Value interface.

func (RelativeTime) String Uses

❖
func (f RelativeTime) String() string

String implements the flag.Value interface.

Directories

PathSynopsis
fixflagpos
flagenumPackage flagenum is a utility package which facilitates implementation of flag.Value, json.Marshaler, and json.Unmarshaler interfaces via a string-to- value mapping.
multiflagPackage multiflag is a package providing a flag.Value implementation capable of switching between multiple registered sub-flags, each of which have their own set of parameter flags.
nestedflagset
stringlistflagPackage stringlistflag provides a flag.Value implementation which resolves multiple args into a []string.
stringmapflagPackage stringmapflag provides a flag.Value that, when parsed, augments a map[string]string with the supplied parameter.
stringsetflagPackage stringsetflag provides a flag.Value implementation which resolves multiple args into a stringset.

Package flag imports 14 packages (graph) and is imported by 23 packages. Updated 2020-12-18. Refresh now. Tools for package owners.