zz_generated.flags.go

Documentation: github.com/urfave/cli/v2

     1  // WARNING: this file is generated. DO NOT EDIT
     2  
     3  package cli
     4  
     5  import "time"
     6  
     7  // Float64SliceFlag is a flag with type *Float64Slice
     8  type Float64SliceFlag struct {
     9  	Name string
    10  
    11  	Category    string
    12  	DefaultText string
    13  	FilePath    string
    14  	Usage       string
    15  
    16  	Required   bool
    17  	Hidden     bool
    18  	HasBeenSet bool
    19  
    20  	Value       *Float64Slice
    21  	Destination *Float64Slice
    22  
    23  	Aliases []string
    24  	EnvVars []string
    25  
    26  	defaultValue    *Float64Slice
    27  	defaultValueSet bool
    28  
    29  	separator separatorSpec
    30  
    31  	Action func(*Context, []float64) error
    32  }
    33  
    34  // IsSet returns whether or not the flag has been set through env or file
    35  func (f *Float64SliceFlag) IsSet() bool {
    36  	return f.HasBeenSet
    37  }
    38  
    39  // Names returns the names of the flag
    40  func (f *Float64SliceFlag) Names() []string {
    41  	return FlagNames(f.Name, f.Aliases)
    42  }
    43  
    44  // IsRequired returns whether or not the flag is required
    45  func (f *Float64SliceFlag) IsRequired() bool {
    46  	return f.Required
    47  }
    48  
    49  // IsVisible returns true if the flag is not hidden, otherwise false
    50  func (f *Float64SliceFlag) IsVisible() bool {
    51  	return !f.Hidden
    52  }
    53  
    54  // GenericFlag is a flag with type Generic
    55  type GenericFlag struct {
    56  	Name string
    57  
    58  	Category    string
    59  	DefaultText string
    60  	FilePath    string
    61  	Usage       string
    62  
    63  	Required   bool
    64  	Hidden     bool
    65  	HasBeenSet bool
    66  
    67  	Value       Generic
    68  	Destination Generic
    69  
    70  	Aliases []string
    71  	EnvVars []string
    72  
    73  	defaultValue    Generic
    74  	defaultValueSet bool
    75  
    76  	TakesFile bool
    77  
    78  	Action func(*Context, interface{}) error
    79  }
    80  
    81  // String returns a readable representation of this value (for usage defaults)
    82  func (f *GenericFlag) String() string {
    83  	return FlagStringer(f)
    84  }
    85  
    86  // IsSet returns whether or not the flag has been set through env or file
    87  func (f *GenericFlag) IsSet() bool {
    88  	return f.HasBeenSet
    89  }
    90  
    91  // Names returns the names of the flag
    92  func (f *GenericFlag) Names() []string {
    93  	return FlagNames(f.Name, f.Aliases)
    94  }
    95  
    96  // IsRequired returns whether or not the flag is required
    97  func (f *GenericFlag) IsRequired() bool {
    98  	return f.Required
    99  }
   100  
   101  // IsVisible returns true if the flag is not hidden, otherwise false
   102  func (f *GenericFlag) IsVisible() bool {
   103  	return !f.Hidden
   104  }
   105  
   106  // Int64SliceFlag is a flag with type *Int64Slice
   107  type Int64SliceFlag struct {
   108  	Name string
   109  
   110  	Category    string
   111  	DefaultText string
   112  	FilePath    string
   113  	Usage       string
   114  
   115  	Required   bool
   116  	Hidden     bool
   117  	HasBeenSet bool
   118  
   119  	Value       *Int64Slice
   120  	Destination *Int64Slice
   121  
   122  	Aliases []string
   123  	EnvVars []string
   124  
   125  	defaultValue    *Int64Slice
   126  	defaultValueSet bool
   127  
   128  	separator separatorSpec
   129  
   130  	Action func(*Context, []int64) error
   131  }
   132  
   133  // IsSet returns whether or not the flag has been set through env or file
   134  func (f *Int64SliceFlag) IsSet() bool {
   135  	return f.HasBeenSet
   136  }
   137  
   138  // Names returns the names of the flag
   139  func (f *Int64SliceFlag) Names() []string {
   140  	return FlagNames(f.Name, f.Aliases)
   141  }
   142  
   143  // IsRequired returns whether or not the flag is required
   144  func (f *Int64SliceFlag) IsRequired() bool {
   145  	return f.Required
   146  }
   147  
   148  // IsVisible returns true if the flag is not hidden, otherwise false
   149  func (f *Int64SliceFlag) IsVisible() bool {
   150  	return !f.Hidden
   151  }
   152  
   153  // IntSliceFlag is a flag with type *IntSlice
   154  type IntSliceFlag struct {
   155  	Name string
   156  
   157  	Category    string
   158  	DefaultText string
   159  	FilePath    string
   160  	Usage       string
   161  
   162  	Required   bool
   163  	Hidden     bool
   164  	HasBeenSet bool
   165  
   166  	Value       *IntSlice
   167  	Destination *IntSlice
   168  
   169  	Aliases []string
   170  	EnvVars []string
   171  
   172  	defaultValue    *IntSlice
   173  	defaultValueSet bool
   174  
   175  	separator separatorSpec
   176  
   177  	Action func(*Context, []int) error
   178  }
   179  
   180  // IsSet returns whether or not the flag has been set through env or file
   181  func (f *IntSliceFlag) IsSet() bool {
   182  	return f.HasBeenSet
   183  }
   184  
   185  // Names returns the names of the flag
   186  func (f *IntSliceFlag) Names() []string {
   187  	return FlagNames(f.Name, f.Aliases)
   188  }
   189  
   190  // IsRequired returns whether or not the flag is required
   191  func (f *IntSliceFlag) IsRequired() bool {
   192  	return f.Required
   193  }
   194  
   195  // IsVisible returns true if the flag is not hidden, otherwise false
   196  func (f *IntSliceFlag) IsVisible() bool {
   197  	return !f.Hidden
   198  }
   199  
   200  // PathFlag is a flag with type Path
   201  type PathFlag struct {
   202  	Name string
   203  
   204  	Category    string
   205  	DefaultText string
   206  	FilePath    string
   207  	Usage       string
   208  
   209  	Required   bool
   210  	Hidden     bool
   211  	HasBeenSet bool
   212  
   213  	Value       Path
   214  	Destination *Path
   215  
   216  	Aliases []string
   217  	EnvVars []string
   218  
   219  	defaultValue    Path
   220  	defaultValueSet bool
   221  
   222  	TakesFile bool
   223  
   224  	Action func(*Context, Path) error
   225  }
   226  
   227  // String returns a readable representation of this value (for usage defaults)
   228  func (f *PathFlag) String() string {
   229  	return FlagStringer(f)
   230  }
   231  
   232  // IsSet returns whether or not the flag has been set through env or file
   233  func (f *PathFlag) IsSet() bool {
   234  	return f.HasBeenSet
   235  }
   236  
   237  // Names returns the names of the flag
   238  func (f *PathFlag) Names() []string {
   239  	return FlagNames(f.Name, f.Aliases)
   240  }
   241  
   242  // IsRequired returns whether or not the flag is required
   243  func (f *PathFlag) IsRequired() bool {
   244  	return f.Required
   245  }
   246  
   247  // IsVisible returns true if the flag is not hidden, otherwise false
   248  func (f *PathFlag) IsVisible() bool {
   249  	return !f.Hidden
   250  }
   251  
   252  // StringSliceFlag is a flag with type *StringSlice
   253  type StringSliceFlag struct {
   254  	Name string
   255  
   256  	Category    string
   257  	DefaultText string
   258  	FilePath    string
   259  	Usage       string
   260  
   261  	Required   bool
   262  	Hidden     bool
   263  	HasBeenSet bool
   264  
   265  	Value       *StringSlice
   266  	Destination *StringSlice
   267  
   268  	Aliases []string
   269  	EnvVars []string
   270  
   271  	defaultValue    *StringSlice
   272  	defaultValueSet bool
   273  
   274  	separator separatorSpec
   275  
   276  	TakesFile bool
   277  
   278  	Action func(*Context, []string) error
   279  
   280  	KeepSpace bool
   281  }
   282  
   283  // IsSet returns whether or not the flag has been set through env or file
   284  func (f *StringSliceFlag) IsSet() bool {
   285  	return f.HasBeenSet
   286  }
   287  
   288  // Names returns the names of the flag
   289  func (f *StringSliceFlag) Names() []string {
   290  	return FlagNames(f.Name, f.Aliases)
   291  }
   292  
   293  // IsRequired returns whether or not the flag is required
   294  func (f *StringSliceFlag) IsRequired() bool {
   295  	return f.Required
   296  }
   297  
   298  // IsVisible returns true if the flag is not hidden, otherwise false
   299  func (f *StringSliceFlag) IsVisible() bool {
   300  	return !f.Hidden
   301  }
   302  
   303  // TimestampFlag is a flag with type *Timestamp
   304  type TimestampFlag struct {
   305  	Name string
   306  
   307  	Category    string
   308  	DefaultText string
   309  	FilePath    string
   310  	Usage       string
   311  
   312  	Required   bool
   313  	Hidden     bool
   314  	HasBeenSet bool
   315  
   316  	Value       *Timestamp
   317  	Destination *Timestamp
   318  
   319  	Aliases []string
   320  	EnvVars []string
   321  
   322  	defaultValue    *Timestamp
   323  	defaultValueSet bool
   324  
   325  	Layout string
   326  
   327  	Timezone *time.Location
   328  
   329  	Action func(*Context, *time.Time) error
   330  }
   331  
   332  // String returns a readable representation of this value (for usage defaults)
   333  func (f *TimestampFlag) String() string {
   334  	return FlagStringer(f)
   335  }
   336  
   337  // IsSet returns whether or not the flag has been set through env or file
   338  func (f *TimestampFlag) IsSet() bool {
   339  	return f.HasBeenSet
   340  }
   341  
   342  // Names returns the names of the flag
   343  func (f *TimestampFlag) Names() []string {
   344  	return FlagNames(f.Name, f.Aliases)
   345  }
   346  
   347  // IsRequired returns whether or not the flag is required
   348  func (f *TimestampFlag) IsRequired() bool {
   349  	return f.Required
   350  }
   351  
   352  // IsVisible returns true if the flag is not hidden, otherwise false
   353  func (f *TimestampFlag) IsVisible() bool {
   354  	return !f.Hidden
   355  }
   356  
   357  // Uint64SliceFlag is a flag with type *Uint64Slice
   358  type Uint64SliceFlag struct {
   359  	Name string
   360  
   361  	Category    string
   362  	DefaultText string
   363  	FilePath    string
   364  	Usage       string
   365  
   366  	Required   bool
   367  	Hidden     bool
   368  	HasBeenSet bool
   369  
   370  	Value       *Uint64Slice
   371  	Destination *Uint64Slice
   372  
   373  	Aliases []string
   374  	EnvVars []string
   375  
   376  	defaultValue    *Uint64Slice
   377  	defaultValueSet bool
   378  
   379  	separator separatorSpec
   380  
   381  	Action func(*Context, []uint64) error
   382  }
   383  
   384  // IsSet returns whether or not the flag has been set through env or file
   385  func (f *Uint64SliceFlag) IsSet() bool {
   386  	return f.HasBeenSet
   387  }
   388  
   389  // Names returns the names of the flag
   390  func (f *Uint64SliceFlag) Names() []string {
   391  	return FlagNames(f.Name, f.Aliases)
   392  }
   393  
   394  // IsRequired returns whether or not the flag is required
   395  func (f *Uint64SliceFlag) IsRequired() bool {
   396  	return f.Required
   397  }
   398  
   399  // IsVisible returns true if the flag is not hidden, otherwise false
   400  func (f *Uint64SliceFlag) IsVisible() bool {
   401  	return !f.Hidden
   402  }
   403  
   404  // UintSliceFlag is a flag with type *UintSlice
   405  type UintSliceFlag struct {
   406  	Name string
   407  
   408  	Category    string
   409  	DefaultText string
   410  	FilePath    string
   411  	Usage       string
   412  
   413  	Required   bool
   414  	Hidden     bool
   415  	HasBeenSet bool
   416  
   417  	Value       *UintSlice
   418  	Destination *UintSlice
   419  
   420  	Aliases []string
   421  	EnvVars []string
   422  
   423  	defaultValue    *UintSlice
   424  	defaultValueSet bool
   425  
   426  	separator separatorSpec
   427  
   428  	Action func(*Context, []uint) error
   429  }
   430  
   431  // IsSet returns whether or not the flag has been set through env or file
   432  func (f *UintSliceFlag) IsSet() bool {
   433  	return f.HasBeenSet
   434  }
   435  
   436  // Names returns the names of the flag
   437  func (f *UintSliceFlag) Names() []string {
   438  	return FlagNames(f.Name, f.Aliases)
   439  }
   440  
   441  // IsRequired returns whether or not the flag is required
   442  func (f *UintSliceFlag) IsRequired() bool {
   443  	return f.Required
   444  }
   445  
   446  // IsVisible returns true if the flag is not hidden, otherwise false
   447  func (f *UintSliceFlag) IsVisible() bool {
   448  	return !f.Hidden
   449  }
   450  
   451  // BoolFlag is a flag with type bool
   452  type BoolFlag struct {
   453  	Name string
   454  
   455  	Category    string
   456  	DefaultText string
   457  	FilePath    string
   458  	Usage       string
   459  
   460  	Required   bool
   461  	Hidden     bool
   462  	HasBeenSet bool
   463  
   464  	Value       bool
   465  	Destination *bool
   466  
   467  	Aliases []string
   468  	EnvVars []string
   469  
   470  	defaultValue    bool
   471  	defaultValueSet bool
   472  
   473  	Count *int
   474  
   475  	DisableDefaultText bool
   476  
   477  	Action func(*Context, bool) error
   478  }
   479  
   480  // String returns a readable representation of this value (for usage defaults)
   481  func (f *BoolFlag) String() string {
   482  	return FlagStringer(f)
   483  }
   484  
   485  // IsSet returns whether or not the flag has been set through env or file
   486  func (f *BoolFlag) IsSet() bool {
   487  	return f.HasBeenSet
   488  }
   489  
   490  // Names returns the names of the flag
   491  func (f *BoolFlag) Names() []string {
   492  	return FlagNames(f.Name, f.Aliases)
   493  }
   494  
   495  // IsRequired returns whether or not the flag is required
   496  func (f *BoolFlag) IsRequired() bool {
   497  	return f.Required
   498  }
   499  
   500  // IsVisible returns true if the flag is not hidden, otherwise false
   501  func (f *BoolFlag) IsVisible() bool {
   502  	return !f.Hidden
   503  }
   504  
   505  // Float64Flag is a flag with type float64
   506  type Float64Flag struct {
   507  	Name string
   508  
   509  	Category    string
   510  	DefaultText string
   511  	FilePath    string
   512  	Usage       string
   513  
   514  	Required   bool
   515  	Hidden     bool
   516  	HasBeenSet bool
   517  
   518  	Value       float64
   519  	Destination *float64
   520  
   521  	Aliases []string
   522  	EnvVars []string
   523  
   524  	defaultValue    float64
   525  	defaultValueSet bool
   526  
   527  	Action func(*Context, float64) error
   528  }
   529  
   530  // String returns a readable representation of this value (for usage defaults)
   531  func (f *Float64Flag) String() string {
   532  	return FlagStringer(f)
   533  }
   534  
   535  // IsSet returns whether or not the flag has been set through env or file
   536  func (f *Float64Flag) IsSet() bool {
   537  	return f.HasBeenSet
   538  }
   539  
   540  // Names returns the names of the flag
   541  func (f *Float64Flag) Names() []string {
   542  	return FlagNames(f.Name, f.Aliases)
   543  }
   544  
   545  // IsRequired returns whether or not the flag is required
   546  func (f *Float64Flag) IsRequired() bool {
   547  	return f.Required
   548  }
   549  
   550  // IsVisible returns true if the flag is not hidden, otherwise false
   551  func (f *Float64Flag) IsVisible() bool {
   552  	return !f.Hidden
   553  }
   554  
   555  // IntFlag is a flag with type int
   556  type IntFlag struct {
   557  	Name string
   558  
   559  	Category    string
   560  	DefaultText string
   561  	FilePath    string
   562  	Usage       string
   563  
   564  	Required   bool
   565  	Hidden     bool
   566  	HasBeenSet bool
   567  
   568  	Value       int
   569  	Destination *int
   570  
   571  	Aliases []string
   572  	EnvVars []string
   573  
   574  	defaultValue    int
   575  	defaultValueSet bool
   576  
   577  	Base int
   578  
   579  	Action func(*Context, int) error
   580  }
   581  
   582  // String returns a readable representation of this value (for usage defaults)
   583  func (f *IntFlag) String() string {
   584  	return FlagStringer(f)
   585  }
   586  
   587  // IsSet returns whether or not the flag has been set through env or file
   588  func (f *IntFlag) IsSet() bool {
   589  	return f.HasBeenSet
   590  }
   591  
   592  // Names returns the names of the flag
   593  func (f *IntFlag) Names() []string {
   594  	return FlagNames(f.Name, f.Aliases)
   595  }
   596  
   597  // IsRequired returns whether or not the flag is required
   598  func (f *IntFlag) IsRequired() bool {
   599  	return f.Required
   600  }
   601  
   602  // IsVisible returns true if the flag is not hidden, otherwise false
   603  func (f *IntFlag) IsVisible() bool {
   604  	return !f.Hidden
   605  }
   606  
   607  // Int64Flag is a flag with type int64
   608  type Int64Flag struct {
   609  	Name string
   610  
   611  	Category    string
   612  	DefaultText string
   613  	FilePath    string
   614  	Usage       string
   615  
   616  	Required   bool
   617  	Hidden     bool
   618  	HasBeenSet bool
   619  
   620  	Value       int64
   621  	Destination *int64
   622  
   623  	Aliases []string
   624  	EnvVars []string
   625  
   626  	defaultValue    int64
   627  	defaultValueSet bool
   628  
   629  	Base int
   630  
   631  	Action func(*Context, int64) error
   632  }
   633  
   634  // String returns a readable representation of this value (for usage defaults)
   635  func (f *Int64Flag) String() string {
   636  	return FlagStringer(f)
   637  }
   638  
   639  // IsSet returns whether or not the flag has been set through env or file
   640  func (f *Int64Flag) IsSet() bool {
   641  	return f.HasBeenSet
   642  }
   643  
   644  // Names returns the names of the flag
   645  func (f *Int64Flag) Names() []string {
   646  	return FlagNames(f.Name, f.Aliases)
   647  }
   648  
   649  // IsRequired returns whether or not the flag is required
   650  func (f *Int64Flag) IsRequired() bool {
   651  	return f.Required
   652  }
   653  
   654  // IsVisible returns true if the flag is not hidden, otherwise false
   655  func (f *Int64Flag) IsVisible() bool {
   656  	return !f.Hidden
   657  }
   658  
   659  // StringFlag is a flag with type string
   660  type StringFlag struct {
   661  	Name string
   662  
   663  	Category    string
   664  	DefaultText string
   665  	FilePath    string
   666  	Usage       string
   667  
   668  	Required   bool
   669  	Hidden     bool
   670  	HasBeenSet bool
   671  
   672  	Value       string
   673  	Destination *string
   674  
   675  	Aliases []string
   676  	EnvVars []string
   677  
   678  	defaultValue    string
   679  	defaultValueSet bool
   680  
   681  	TakesFile bool
   682  
   683  	Action func(*Context, string) error
   684  }
   685  
   686  // String returns a readable representation of this value (for usage defaults)
   687  func (f *StringFlag) String() string {
   688  	return FlagStringer(f)
   689  }
   690  
   691  // IsSet returns whether or not the flag has been set through env or file
   692  func (f *StringFlag) IsSet() bool {
   693  	return f.HasBeenSet
   694  }
   695  
   696  // Names returns the names of the flag
   697  func (f *StringFlag) Names() []string {
   698  	return FlagNames(f.Name, f.Aliases)
   699  }
   700  
   701  // IsRequired returns whether or not the flag is required
   702  func (f *StringFlag) IsRequired() bool {
   703  	return f.Required
   704  }
   705  
   706  // IsVisible returns true if the flag is not hidden, otherwise false
   707  func (f *StringFlag) IsVisible() bool {
   708  	return !f.Hidden
   709  }
   710  
   711  // DurationFlag is a flag with type time.Duration
   712  type DurationFlag struct {
   713  	Name string
   714  
   715  	Category    string
   716  	DefaultText string
   717  	FilePath    string
   718  	Usage       string
   719  
   720  	Required   bool
   721  	Hidden     bool
   722  	HasBeenSet bool
   723  
   724  	Value       time.Duration
   725  	Destination *time.Duration
   726  
   727  	Aliases []string
   728  	EnvVars []string
   729  
   730  	defaultValue    time.Duration
   731  	defaultValueSet bool
   732  
   733  	Action func(*Context, time.Duration) error
   734  }
   735  
   736  // String returns a readable representation of this value (for usage defaults)
   737  func (f *DurationFlag) String() string {
   738  	return FlagStringer(f)
   739  }
   740  
   741  // IsSet returns whether or not the flag has been set through env or file
   742  func (f *DurationFlag) IsSet() bool {
   743  	return f.HasBeenSet
   744  }
   745  
   746  // Names returns the names of the flag
   747  func (f *DurationFlag) Names() []string {
   748  	return FlagNames(f.Name, f.Aliases)
   749  }
   750  
   751  // IsRequired returns whether or not the flag is required
   752  func (f *DurationFlag) IsRequired() bool {
   753  	return f.Required
   754  }
   755  
   756  // IsVisible returns true if the flag is not hidden, otherwise false
   757  func (f *DurationFlag) IsVisible() bool {
   758  	return !f.Hidden
   759  }
   760  
   761  // UintFlag is a flag with type uint
   762  type UintFlag struct {
   763  	Name string
   764  
   765  	Category    string
   766  	DefaultText string
   767  	FilePath    string
   768  	Usage       string
   769  
   770  	Required   bool
   771  	Hidden     bool
   772  	HasBeenSet bool
   773  
   774  	Value       uint
   775  	Destination *uint
   776  
   777  	Aliases []string
   778  	EnvVars []string
   779  
   780  	defaultValue    uint
   781  	defaultValueSet bool
   782  
   783  	Base int
   784  
   785  	Action func(*Context, uint) error
   786  }
   787  
   788  // String returns a readable representation of this value (for usage defaults)
   789  func (f *UintFlag) String() string {
   790  	return FlagStringer(f)
   791  }
   792  
   793  // IsSet returns whether or not the flag has been set through env or file
   794  func (f *UintFlag) IsSet() bool {
   795  	return f.HasBeenSet
   796  }
   797  
   798  // Names returns the names of the flag
   799  func (f *UintFlag) Names() []string {
   800  	return FlagNames(f.Name, f.Aliases)
   801  }
   802  
   803  // IsRequired returns whether or not the flag is required
   804  func (f *UintFlag) IsRequired() bool {
   805  	return f.Required
   806  }
   807  
   808  // IsVisible returns true if the flag is not hidden, otherwise false
   809  func (f *UintFlag) IsVisible() bool {
   810  	return !f.Hidden
   811  }
   812  
   813  // Uint64Flag is a flag with type uint64
   814  type Uint64Flag struct {
   815  	Name string
   816  
   817  	Category    string
   818  	DefaultText string
   819  	FilePath    string
   820  	Usage       string
   821  
   822  	Required   bool
   823  	Hidden     bool
   824  	HasBeenSet bool
   825  
   826  	Value       uint64
   827  	Destination *uint64
   828  
   829  	Aliases []string
   830  	EnvVars []string
   831  
   832  	defaultValue    uint64
   833  	defaultValueSet bool
   834  
   835  	Base int
   836  
   837  	Action func(*Context, uint64) error
   838  }
   839  
   840  // String returns a readable representation of this value (for usage defaults)
   841  func (f *Uint64Flag) String() string {
   842  	return FlagStringer(f)
   843  }
   844  
   845  // IsSet returns whether or not the flag has been set through env or file
   846  func (f *Uint64Flag) IsSet() bool {
   847  	return f.HasBeenSet
   848  }
   849  
   850  // Names returns the names of the flag
   851  func (f *Uint64Flag) Names() []string {
   852  	return FlagNames(f.Name, f.Aliases)
   853  }
   854  
   855  // IsRequired returns whether or not the flag is required
   856  func (f *Uint64Flag) IsRequired() bool {
   857  	return f.Required
   858  }
   859  
   860  // IsVisible returns true if the flag is not hidden, otherwise false
   861  func (f *Uint64Flag) IsVisible() bool {
   862  	return !f.Hidden
   863  }
   864  
   865  // vim:ro
   866
View as plain text