layers

Mar 20, 2024

Changes in this version

+ func InitializeParameterLayerWithDefaults(v ParameterLayer, parsedLayer *ParsedLayer, ...) error

type ParameterLayers

+ func (pl *ParameterLayers) InitializeFromDefaults(options ...parameters.ParseStepOption) (*ParsedLayers, error)

+ func (pl *ParameterLayers) UpdateWithDefaults(parsedLayers *ParsedLayers, options ...parameters.ParseStepOption) error

type ParsedLayers

+ func (p *ParsedLayers) Clone() *ParsedLayers

Jan 17, 2024

Changes in this version

+ const GlobalDefaultSlug

type FlagGroupUsage

+ Slug string

Jan 9, 2024

Changes in this version

type ParameterLayers

+ func (pl *ParameterLayers) AddToCobraCommand(cmd *cobra.Command) error

Jan 3, 2024

Changes in this version

+ const DefaultSlug

+ type BlacklistParameterLayer struct

+ BlacklistedParameters map[string]interface{}

+ func NewBlacklistParameterLayer(layer ParameterLayer, blacklistedParameters map[string]interface{}) *BlacklistParameterLayer

+ func (l *BlacklistParameterLayer) GetParameterDefinitions() *parameters.ParameterDefinitions

type CobraParameterLayer

+ AddLayerToCobraCommand func(cmd *cobra.Command) error

+ ParseLayerFromCobraCommand func(cmd *cobra.Command, options ...parameters.ParseStepOption) (*ParsedLayer, error)

type ParameterLayer

+ AddFlags func(flag ...*parameters.ParameterDefinition)

+ Clone func() ParameterLayer

type ParameterLayerImpl

+ ParameterDefinitions *parameters.ParameterDefinitions

+ func (p *ParameterLayerImpl) AddFlags(flag ...*parameters.ParameterDefinition)

+ func (p *ParameterLayerImpl) AddLayerToCobraCommand(cmd *cobra.Command) error

+ func (p *ParameterLayerImpl) Clone() ParameterLayer

+ func (p *ParameterLayerImpl) GatherParametersFromMap(m map[string]interface{}, onlyProvided bool, ...) (*parameters.ParsedParameters, error)

+ func (p *ParameterLayerImpl) ParseLayerFromCobraCommand(cmd *cobra.Command, options ...parameters.ParseStepOption) (*ParsedLayer, error)

type ParameterLayerOptions

+ func WithArguments(arguments ...*parameters.ParameterDefinition) ParameterLayerOptions

+ func WithParameterDefinitions(parameterDefinitions ...*parameters.ParameterDefinition) ParameterLayerOptions

+ type ParameterLayers struct

+ func NewParameterLayers(options ...ParameterLayersOption) *ParameterLayers

+ func (pl *ParameterLayers) AppendLayers(layers ...ParameterLayer)

+ func (pl *ParameterLayers) AsList() []ParameterLayer

+ func (pl *ParameterLayers) Clone() *ParameterLayers

+ func (pl *ParameterLayers) ForEach(f func(key string, p ParameterLayer))

+ func (pl *ParameterLayers) ForEachE(f func(key string, p ParameterLayer) error) error

+ func (pl *ParameterLayers) GetAllParameterDefinitions() *parameters.ParameterDefinitions

+ func (pl *ParameterLayers) Merge(p *ParameterLayers) *ParameterLayers

+ func (pl *ParameterLayers) PrependLayers(layers ...ParameterLayer)

+ func (pl *ParameterLayers) Subset(slugs ...string) *ParameterLayers

+ type ParameterLayersOption func(*ParameterLayers)

+ func WithLayers(layers ...ParameterLayer) ParameterLayersOption

+ type ParsedLayer struct

+ Layer ParameterLayer

+ Parameters *parameters.ParsedParameters

+ func NewParsedLayer(layer ParameterLayer, options ...ParsedLayerOption) (*ParsedLayer, error)

+ func (ppl *ParsedLayer) Clone() *ParsedLayer

+ func (ppl *ParsedLayer) GetParameter(k string) (interface{}, bool)

+ func (ppl *ParsedLayer) InitializeStruct(s interface{}) error

+ func (ppl *ParsedLayer) MergeParameters(other *ParsedLayer)

+ type ParsedLayerOption func(*ParsedLayer) error

+ func WithParsedParameterValue(key string, value interface{}, options ...parameters.ParseStepOption) ParsedLayerOption

+ func WithParsedParameters(pds *parameters.ParsedParameters) ParsedLayerOption

+ type ParsedLayers struct

+ func NewParsedLayers(options ...ParsedLayersOption) *ParsedLayers

+ func (p *ParsedLayers) ForEach(fn func(k string, v *ParsedLayer))

+ func (p *ParsedLayers) ForEachE(fn func(k string, v *ParsedLayer) error) error

+ func (p *ParsedLayers) GetAllParsedParameters() *parameters.ParsedParameters

+ func (p *ParsedLayers) GetDataMap() map[string]interface{}

+ func (p *ParsedLayers) GetDefaultParameterLayer() *ParsedLayer

+ func (p *ParsedLayers) GetOrCreate(layer ParameterLayer) *ParsedLayer

+ func (p *ParsedLayers) GetParameter(slug string, key string) (*parameters.ParsedParameter, bool)

+ func (p *ParsedLayers) InitializeStruct(key string, s interface{}) error

+ type ParsedLayersOption func(*ParsedLayers)

+ func WithParsedLayer(slug string, v *ParsedLayer) ParsedLayersOption

+ type WhitelistParameterLayer struct

+ WhitelistedParameters map[string]interface{}

+ func NewWhitelistParameterLayer(layer ParameterLayer, whitelistedParameters map[string]interface{}) *WhitelistParameterLayer

+ func (l *WhitelistParameterLayer) GetParameterDefinitions() *parameters.ParameterDefinitions

Sep 28, 2023

Changes in this version

+ type ErrInvalidParameterLayer struct

+ Expected string

+ Name string

+ func (e ErrInvalidParameterLayer) Error() string

type ParameterLayerOptions

+ func WithName(name string) ParameterLayerOptions

Sep 18, 2023

Changes in this version

+ type JSONParameterLayer interface

+ ParseFlagsFromJSON func(m map[string]interface{}, onlyProvided bool) (map[string]interface{}, error)

type ParameterLayerImpl

+ func (p *ParameterLayerImpl) ParseFlagsFromJSON(m map[string]interface{}, onlyProvided bool) (map[string]interface{}, error)

Aug 7, 2023

Changes in this version

type ParameterLayerImpl

+ ChildLayers []ParameterLayer

Jun 20, 2023

Changes in this version

type ParsedParameterLayer

+ func (ppl *ParsedParameterLayer) MergeParameters(other *ParsedParameterLayer)

Mar 21, 2023

Changes in this version

type ParameterLayerImpl

+ func (p *ParameterLayerImpl) GetParameterValuesFromMap(m map[string]interface{}) (map[string]interface{}, error)

Mar 21, 2023

Changes in this version

type FlagGroup

+ Prefix string

Mar 1, 2023

Changes in this version

type ParameterLayerImpl

+ func (p *ParameterLayerImpl) InitializeParameterDefaultsFromParameters(ps map[string]interface{}) error

type ParsedParameterLayer

+ func (ppl *ParsedParameterLayer) Clone() *ParsedParameterLayer

Feb 27, 2023

Changes in this version

+ type CobraParameterLayer interface

+ AddFlagsToCobraCommand func(cmd *cobra.Command) error

+ ParseFlagsFromCobraCommand func(cmd *cobra.Command) (map[string]interface{}, error)

+ type CobraParameterLayerParser struct

+ Cmd *cobra.Command

+ func NewCobraParameterLayerParser(cmd *cobra.Command) *CobraParameterLayerParser

+ func (c *CobraParameterLayerParser) RegisterParameterLayer(layer ParameterLayer) (ParameterLayerParserFunc, error)

type ParameterLayer

+ GetPrefix func() string

type ParameterLayerImpl

+ Prefix string

+ func (p *ParameterLayerImpl) GetPrefix() string

type ParameterLayerOptions

+ func WithDefaults(s interface{}) ParameterLayerOptions

+ func WithPrefix(prefix string) ParameterLayerOptions

+ type ParameterLayerParser interface

+ RegisterParameterLayer func(ParameterLayer) (ParameterLayerParserFunc, error)

+ type ParameterLayerParserFunc func() (*ParsedParameterLayer, error)

+ type ParsedParameterLayer struct

+ Layer ParameterLayer

+ Parameters map[string]interface{}

Feb 22, 2023

Changes in this version

type ParameterLayer

+ GetDescription func() string

+ GetName func() string

+ GetSlug func() string

+ InitializeParameterDefaultsFromStruct func(s interface{}) error

+ InitializeStructFromParameterDefaults func(s interface{}) error

type ParameterLayerImpl

+ func (p *ParameterLayerImpl) GetDescription() string

+ func (p *ParameterLayerImpl) GetName() string

+ func (p *ParameterLayerImpl) GetSlug() string

+ func (p *ParameterLayerImpl) InitializeParameterDefaultsFromStruct(defaults interface{}) error

+ func (p *ParameterLayerImpl) InitializeParameterDefinitionsFromParameters(ps map[string]interface{}) error

+ func (p *ParameterLayerImpl) InitializeStructFromParameterDefaults(s interface{}) error

Feb 22, 2023

Changes in this version

+ func AddFlagGroupToCobraCommand(cmd *cobra.Command, id string, name string, ...)

+ func SetFlagGroupOrder(cmd *cobra.Command, order []string)

+ type CommandFlagGroupUsage struct

+ InheritedGroupUsages []*FlagGroupUsage

+ LocalGroupUsages []*FlagGroupUsage

+ func ComputeCommandFlagGroupUsage(c *cobra.Command) *CommandFlagGroupUsage

+ func (c *CommandFlagGroupUsage) String() string

+ type FlagGroup struct

+ Flags []string

+ ID string

+ Name string

+ Order int

+ func GetFlagGroups(cmd *cobra.Command) []*FlagGroup

+ type FlagGroupUsage struct

+ FlagUsages []*FlagUsage

+ MaxFlagLength int

+ Name string

+ func (f *FlagGroupUsage) AddFlagUsage(flag *FlagUsage)

+ func (f *FlagGroupUsage) String() string

+ type FlagUsage struct

+ Default string

+ FlagString string

+ Help string

+ Long string

+ ShortHand string

+ type ParameterLayer interface

+ AddFlag func(flag *parameters.ParameterDefinition)

+ AddFlagsToCobraCommand func(cmd *cobra.Command, defaults interface{}) error

+ GetParameterDefinitions func() map[string]*parameters.ParameterDefinition

+ InitializeStructFromDefaults func(s interface{}) error

+ ParseFlagsFromCobraCommand func(cmd *cobra.Command) (map[string]interface{}, error)

+ type ParameterLayerImpl struct

+ Description string

+ Flags []*parameters.ParameterDefinition

+ Name string

+ Slug string

+ func NewParameterLayer(slug string, name string, options ...ParameterLayerOptions) *ParameterLayerImpl

+ func NewParameterLayerFromYAML(s []byte) (*ParameterLayerImpl, error)

+ func (p *ParameterLayerImpl) AddFlag(flag *parameters.ParameterDefinition)

+ func (p *ParameterLayerImpl) AddFlagsToCobraCommand(cmd *cobra.Command, defaults interface{}) error

+ func (p *ParameterLayerImpl) GetParameterDefinitions() map[string]*parameters.ParameterDefinition

+ func (p *ParameterLayerImpl) InitializeStructFromDefaults(s interface{}) error

+ func (p *ParameterLayerImpl) LoadFromYAML(s []byte) error

+ func (p *ParameterLayerImpl) ParseFlagsFromCobraCommand(cmd *cobra.Command) (map[string]interface{}, error)

+ func (p *ParameterLayerImpl) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type ParameterLayerOptions func(*ParameterLayerImpl)

+ func WithDescription(description string) ParameterLayerOptions

+ func WithFlags(flags ...*parameters.ParameterDefinition) ParameterLayerOptions