descriptor

Documentation

Index

• Variables
• func Descriptors() []string
• func Register(name string, descriptor Descriptor)
• type Command
• type Commands
• type Descriptor
  • func Find(name string) (Descriptor, error)
• type NSCommand
  • func (n *NSCommand) Append(name, desc string)
• type ShortCommand

Variables

var ErrDescriptorNotFound = errors.New("descriptor not found")

Functions

func Descriptors

func Descriptors() []string

func Register

func Register(name string, descriptor Descriptor)

Types

type Command

type Command struct {
	Bin         string
	Name        string
	Description string
	Help        string
	Definition  *input.Definition
}

type Commands

type Commands struct {
	Namespace  string
	Definition *input.Definition
	Commands   []NSCommand
}

type Descriptor

type Descriptor interface {
	Command(ctx context.Context, out output.Output, cmd Command) error
	Commands(ctx context.Context, out output.Output, cmds Commands) error
}

func Find

func Find(name string) (Descriptor, error)

type NSCommand

type NSCommand struct {
	Name     string
	Commands []ShortCommand
}

func (*NSCommand) Append

func (n *NSCommand) Append(name, desc string)

type ShortCommand

type ShortCommand struct {
	Name        string
	Description string
}