common

package
v0.13.0 Latest Latest
Warning

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

Go to latest
Published: Aug 5, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DescribeAccessMethods

func DescribeAccessMethods(d *descriptor.Descriptor, out common.Printer)

func DescribeActions

func DescribeActions(reg api.ActionTypeRegistry, d *descriptor.Descriptor, out common.Printer)

func DescribeCLIExtensions added in v0.12.0

func DescribeCLIExtensions(d *descriptor.Descriptor, out common.Printer)

func DescribeConfigTypes added in v0.12.0

func DescribeConfigTypes(d *descriptor.Descriptor, out common.Printer)

func DescribeElements

func DescribeElements[E Element[C], C Stringer](elems []E) string

func DescribeLabelMergeSpecifications added in v0.4.1

func DescribeLabelMergeSpecifications(d *descriptor.Descriptor, out common.Printer)

func DescribePluginDescriptor

func DescribePluginDescriptor(reg api.ActionTypeRegistry, d *descriptor.Descriptor, out common.Printer)

func DescribePluginDescriptorCapabilities added in v0.4.1

func DescribePluginDescriptorCapabilities(reg api.ActionTypeRegistry, d *descriptor.Descriptor, out common.Printer)

func DescribeValueMergeHandlers added in v0.4.1

func DescribeValueMergeHandlers(d *descriptor.Descriptor, out common.Printer)

func DescribeValueSets added in v0.4.1

func DescribeValueSets(d *descriptor.Descriptor, out common.Printer)

func GetAccessMethodInfo

func GetAccessMethodInfo(methods []descriptor.AccessMethodDescriptor) map[string]*MethodInfo

func GetActionInfo

func GetActionInfo(reg api.ActionTypeRegistry, actions []descriptor.ActionDescriptor) map[string]*ActionInfo

func GetTypeInfo added in v0.12.0

func GetTypeInfo(types []descriptor.ConfigTypeDescriptor) map[string]*TypeInfo

func GetValueSetInfo added in v0.4.1

func GetValueSetInfo(valuesets []descriptor.ValueSetDescriptor) map[string]*ValueSetInfo

func ListElements

func ListElements[E DescribableElement[C], C Describable](msg string, elems []E, out common.Printer)

ListElements lists describable elements.

Types

type ActionInfo

type ActionInfo struct {
	ActionDesc    string
	Versions      []string
	Selectors     []string
	ConsumerType  string
	Attributes    []string
	Description   string
	Usage         string
	KnownVersions []string
	BestVersion   string
	Error         string
}

type Describable

type Describable interface {
	Describe() string
}

type DescribableElement

type DescribableElement[C Describable] interface {
	GetName() string
	GetDescription() string
	GetConstraints() []C
}

type Element

type Element[C Stringer] interface {
	GetName() string
	GetConstraints() []C
}

type MethodInfo

type MethodInfo struct {
	Name        string
	Description string
	Versions    map[string]*MethodVersion
}

type MethodVersion

type MethodVersion struct {
	Name    string
	Format  string
	Options map[string]options.OptionType
}

type Stringer

type Stringer interface {
	String() string
}

type TypeInfo added in v0.12.0

type TypeInfo struct {
	Name        string
	Description string
	Versions    map[string]*TypeVersion
}

type TypeVersion added in v0.12.0

type TypeVersion struct {
	Name   string
	Format string
}

type ValueSetInfo added in v0.4.1

type ValueSetInfo struct {
	Name        string
	Description string
	Purposes    set.Set[string]
	Versions    map[string]*ValueSetVersion
}

type ValueSetVersion added in v0.4.1

type ValueSetVersion struct {
	Name    string
	Format  string
	Options map[string]options.OptionType
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL