common

Documentation

Index

• func DescribeAccessMethods(p plugin.Plugin, out common.Printer)
• func DescribeElements[E Element[C], C Stringer](elems []E) string
• func DescribePlugin(p plugin.Plugin, out common.Printer)
• func GetAccessMethodInfo(methods []plugin.AccessMethodDescriptor) map[string]*MethodInfo
• func ListElements[E DescribableElement[C], C Describable](msg string, elems []E, out common.Printer)
• type Describable
• type DescribableElement
• type Element
• type MethodInfo
• type MethodVersion
• type Stringer

Functions

func DescribeAccessMethods

func DescribeAccessMethods(p plugin.Plugin, out common.Printer)

func DescribeElements

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

func DescribePlugin

func DescribePlugin(p plugin.Plugin, out common.Printer)

func GetAccessMethodInfo

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

func ListElements

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

Types

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
}