Documentation
¶
Index ¶
- Variables
- type AlloyFilterParameterSet
- type CascadeParameterSet
- type CliInteractionParameterSet
- type FilesFilterParameterSet
- type FlagDefinitions
- type FoldersFilterParameterSet
- type I18nParameterSet
- type LongFlagName
- type PolyFilterParameterSet
- type PreviewParameterSet
- type ProfileParameterSet
- type SamplingParameterSet
- type ShortFlagName
- type TextualInteractionParameterSet
- type WorkerPoolParameterSet
Constants ¶
This section is empty.
Variables ¶
var ShortFlags = FlagDefinitions{
"cpu": "",
"now": "",
"dry-run": "D",
"files": "F",
"files-gb": "G",
"files-rx": "X",
"folders-gb": "Z",
"folders-rx": "Y",
"profile": "P",
"scheme": "S",
"language": "",
"depth": "",
"no-recurse": "N",
"sample": "",
"no-files": "",
"no-folders": "",
"last": "",
"tui": "",
}
Functions ¶
This section is empty.
Types ¶
type AlloyFilterParameterSet ¶ added in v0.4.3
AlloyFilterParameterSet represents a family of parameters that can be used to accept file and folder filters. Files are represented by an extended glob and folders by a regular glob.
func (*AlloyFilterParameterSet) BindAll ¶ added in v0.4.3
func (f *AlloyFilterParameterSet) BindAll( parent *assistant.ParamSet[AlloyFilterParameterSet], flagSet ...*pflag.FlagSet, )
type CascadeParameterSet ¶ added in v0.4.2
func (*CascadeParameterSet) BindAll ¶ added in v0.4.2
func (f *CascadeParameterSet) BindAll( parent *assistant.ParamSet[CascadeParameterSet], flagSet ...*pflag.FlagSet, )
type CliInteractionParameterSet ¶ added in v0.4.5
type CliInteractionParameterSet struct {
IsTUI bool
}
func (*CliInteractionParameterSet) BindAll ¶ added in v0.4.5
func (f *CliInteractionParameterSet) BindAll( parent *assistant.ParamSet[CliInteractionParameterSet], flagSet ...*pflag.FlagSet, )
type FilesFilterParameterSet ¶ added in v0.3.6
FilesFilterParameterSet represents a family of parameters that can be used to accept a file filter. files is considered the default as it is the most user friendly to use, as a glob is easier and more intuitive to use on the command line and supports (with te help of a delimiter) multiple extensions to be specified with a csv, in contrast to a regular glob.
func (*FilesFilterParameterSet) BindAll ¶ added in v0.3.6
func (f *FilesFilterParameterSet) BindAll( parent *assistant.ParamSet[FilesFilterParameterSet], flagSet ...*pflag.FlagSet, )
type FlagDefinitions ¶ added in v0.4.0
type FlagDefinitions map[LongFlagName]ShortFlagName
type FoldersFilterParameterSet ¶ added in v0.3.6
FoldersFilterParameterSet represents a family of parameters that can be used to accept a folder filter. In contrast to files, the folders family does not include an extended glob because folders do not contain extensions, so the regular glob will suffice.
func (*FoldersFilterParameterSet) BindAll ¶ added in v0.3.6
func (f *FoldersFilterParameterSet) BindAll( parent *assistant.ParamSet[FoldersFilterParameterSet], flagSet ...*pflag.FlagSet, )
type I18nParameterSet ¶ added in v0.4.0
type I18nParameterSet struct {
Language string
}
func (*I18nParameterSet) BindAll ¶ added in v0.4.0
func (f *I18nParameterSet) BindAll( parent *assistant.ParamSet[I18nParameterSet], flagSet ...*pflag.FlagSet, )
type LongFlagName ¶ added in v0.4.0
type LongFlagName = string
type PolyFilterParameterSet ¶ added in v0.3.6
type PolyFilterParameterSet struct { Files string FilesRexEx string FoldersGlob string FoldersRexEx string }
PolyFilterParameterSet represents a family of parameters that can be used to accept file and folder filters. This family is composed of files and filters. For files, either an extended glob or regex is supported. For folders, either a regular glob or regex is supported.
func (*PolyFilterParameterSet) BindAll ¶ added in v0.3.6
func (f *PolyFilterParameterSet) BindAll( parent *assistant.ParamSet[PolyFilterParameterSet], flagSet ...*pflag.FlagSet, )
type PreviewParameterSet ¶
type PreviewParameterSet struct {
DryRun bool
}
func (*PreviewParameterSet) BindAll ¶
func (f *PreviewParameterSet) BindAll( parent *assistant.ParamSet[PreviewParameterSet], flagSet ...*pflag.FlagSet, )
type ProfileParameterSet ¶
func (*ProfileParameterSet) BindAll ¶
func (f *ProfileParameterSet) BindAll( parent *assistant.ParamSet[ProfileParameterSet], flagSet ...*pflag.FlagSet, )
type SamplingParameterSet ¶ added in v0.4.5
func (*SamplingParameterSet) BindAll ¶ added in v0.4.5
func (f *SamplingParameterSet) BindAll( parent *assistant.ParamSet[SamplingParameterSet], flagSet ...*pflag.FlagSet, )
type ShortFlagName ¶ added in v0.4.0
type ShortFlagName = string
type TextualInteractionParameterSet ¶ added in v0.4.5
type TextualInteractionParameterSet struct {
IsNoTui bool
}
func (*TextualInteractionParameterSet) BindAll ¶ added in v0.4.5
func (f *TextualInteractionParameterSet) BindAll( parent *assistant.ParamSet[TextualInteractionParameterSet], flagSet ...*pflag.FlagSet, )
type WorkerPoolParameterSet ¶
func (*WorkerPoolParameterSet) BindAll ¶
func (f *WorkerPoolParameterSet) BindAll( parent *assistant.ParamSet[WorkerPoolParameterSet], flagSet ...*pflag.FlagSet, )