goflags

Documentation

Index

• Variables
• func DefaultUsage()
• func Parse(config interface{}) (err error)
• func PrintDefaults()
• func Reset()
• func SetTag(tag string)
• func SetTagDefault(tag string)
• func SetTagHelper(tag string)
• func Setup(tag, tagDefault, TagHelper string)

Variables

var (

	// Preserve disable default values and get only visited parameters thus preserving the values passed in the structure, default false
	Preserve bool

	// Prefix is a string that would be placed at the beginning of the generated tags.
	Prefix string

	//Usage is a function to show the help, can be replaced by your own version.
	Usage func()
)

Functions

func DefaultUsage

func DefaultUsage()

DefaultUsage is assigned for Usage function by default

func Parse

func Parse(config interface{}) (err error)

Parse configuration

func PrintDefaults

func PrintDefaults()

PrintDefaults print the default help

func Reset

func Reset()

Reset maps caling setup function

func SetTag

func SetTag(tag string)

SetTag set a new tag

func SetTagDefault

func SetTagDefault(tag string)

SetTagDefault set a new TagDefault to retorn default values

func SetTagHelper

func SetTagHelper(tag string)

SetTagHelper set a new TagHelper

func Setup

func Setup(tag, tagDefault, TagHelper string)

Setup maps and variables