flag

package
v1.4.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 1, 2021 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Arg 

type Arg struct {
	// contains filtered or unexported fields
}

Arg représente un argument de commande

func NewArg 

func NewArg(name, usage string, nbargs int, value *[]string) *Arg

NewArg retourne un nouvel argument avec son nom, sa description le nombre d’éléments attendu et un pointeur vers la valeur parsée. Si nbargs < 0, l’argument peut recevoir un nombre d’éléments indéterminé Si nbargs = 0, l’argument est facultatif

func (*Arg) IsParsed 

func (a *Arg) IsParsed() bool

IsParsed retourne vrai si l’argument a déjà été parsé

func (*Arg) Name 

func (a *Arg) Name() string

func (*Arg) Parse 

func (a *Arg) Parse(args []string) (next []string, err error)

Parse parse l’argument à partir de l’entrée fournie et retourne les éléments restant à parser. Si le parsage échoue, une erreur est retournée.

func (*Arg) Reset 

func (a *Arg) Reset()

Reset réinitialise le parsage

func (*Arg) Usage 

func (a *Arg) Usage() string

type ConversionFunc 

type ConversionFunc func(args []string) (next []string, val interface{}, parsed int, err error)

ConversionFunc est une fonction de conversion Les éléments retournés sont : - next : liste des éléments restants à parser - val : la valeur parsée - err : une erreur si le parsage échoue

type Flag 

type Flag struct {
	// contains filtered or unexported fields
}

Flag représente un argument nommé de commande

func Bool 

func Bool(name, usage string, value *bool, defaultval bool, fac bool, others ...string) *Flag

Int retourne un argument nommé sans argument supplémentaire

func BoolSlice 

func BoolSlice(name, usage string, nb int, value *[]bool, defaultval []bool, others ...string) *Flag

BoolSlice retourne un argument nommé de type tableau de booléens

func Float 

func Float(name, usage string, value *float64, defaultval float64, fac bool, others ...string) *Flag

Flot retourne un argument nommé de type décimal

func FloatSlice 

func FloatSlice(name, usage string, nb int, value *[]float64, defaultval []float64, others ...string) *Flag

FloatSlice retourne un argument nommé de type tableau de nombres

func Int 

func Int(name, usage string, value *int, defaultval int, fac bool, others ...string) *Flag

Int retourne un argument nommé de type entier

func IntSlice 

func IntSlice(name, usage string, nb int, value *[]int, defaultval []int, others ...string) *Flag

IntSlice retourne un argument nommé de type tableau d’entiers

func New 

func New(name, usage, argname string, value, defaultval interface{}, nb int, conv ConversionFunc, others ...string) *Flag

New retourne un nouvel argument nommé avec : - son nom, - son usage, - le nom donné à l’argument qui suit - un pointeur vers sa valeur - sa valeur par défaut si non parsé - son nombre d’arguments (indéfini si -1, optionnel si 0) - sa fonction de conversion - des noms supplémentaires

func String 

func String(name, usage string, value *string, defaultval string, fac bool, others ...string) *Flag

String retourne un argument nommé de type chaîne de caractères

func StringSlice 

func StringSlice(name, usage string, nb int, value *[]string, defaultval []string, others ...string) *Flag

StringSlice retourne un argument nommé de type tableau de strings

func Uint 

func Uint(name, usage string, value *uint, defaultval uint, fac bool, others ...string) *Flag

Uint retourne un argument nommé de type entier non signé

func UintSlice 

func UintSlice(name, usage string, nb int, value *[]uint, defaultval []uint, others ...string) *Flag

UintSlice retourne un argument nommé de type tableau d’entiers non signés

func (*Flag) ArgName 

func (f *Flag) ArgName() string

func (*Flag) Flags 

func (f *Flag) Flags() []string

Flags retourne les noms possibles permettant d’identifier l’argument

func (*Flag) IsParsed 

func (f *Flag) IsParsed() bool

IsParsed retourne vrai si l’argument a déjà été parsé

func (*Flag) Name 

func (f *Flag) Name() string

func (*Flag) Parse 

func (f *Flag) Parse(args []string) (next []string, err error)

Parse parse l’argument à partir de l’entrée fournie et retourne les éléments restant à parser. Si le parsage échoue, une erreur est retournée.

func (*Flag) Reset 

func (f *Flag) Reset()

Reset réinitialise le parsage

func (*Flag) Usage 

func (f *Flag) Usage() string

func (*Flag) Value 

func (f *Flag) Value() interface{}

Value retourne la valeur parsée de l’argument

type FlagSet 

type FlagSet struct {
	// contains filtered or unexported fields
}

FlagSet et un ensemble de flags

func NewSet 

func NewSet(unix bool) *FlagSet

NewSet retourne un nouveau set de flags Si unix, les arguments nommés doivent être de type unix : -n pour les noms courts et --name pour les noms longs

func (*FlagSet) Add 

func (fs *FlagSet) Add(flags ...*Flag) *FlagSet

func (*FlagSet) AddArgs 

func (fs *FlagSet) AddArgs(args ...*Arg) *FlagSet

func (*FlagSet) Args 

func (fs *FlagSet) Args() []string

func (*FlagSet) Flags 

func (fs *FlagSet) Flags() []command.Flag

func (*FlagSet) Help 

func (fs *FlagSet) Help() string

func (*FlagSet) HelpRequired 

func (fs *FlagSet) HelpRequired() bool

HelpRequired retourne vrai si le parsage contient un flag de type aide

func (*FlagSet) IsParsed 

func (fs *FlagSet) IsParsed() bool

func (*FlagSet) Parse 

func (fs *FlagSet) Parse(args []string) (next []string, err error)

func (*FlagSet) Reset 

func (fs *FlagSet) Reset()

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.