plugin

Documentation

Index

• type Help
  • func (h *Help) Show() error
• type Plugin
  • func (p *Plugin) GetMetadata() cfplugin.PluginMetadata
  • func (p *Plugin) Help(name string)
  • func (p *Plugin) Install() error
  • func (p *Plugin) Run(cliConnection cfplugin.CliConnection, args []string)
• type UI
  • func (u *UI) Error(err error)
  • func (u *UI) Output(format string, a ...interface{})
  • func (u *UI) Prompt(message string) string
  • func (u *UI) Warn(format string, a ...interface{})
• type UserInterface

Types

type Help

type Help struct {
	CLI cfplugin.CliConnection
}

func (*Help) Show

func (h *Help) Show() error

type Plugin

type Plugin struct {
	UI       UserInterface
	Version  string
	RunErr   error
	ExitChan chan struct{}
}

func (*Plugin) GetMetadata

func (p *Plugin) GetMetadata() cfplugin.PluginMetadata

func (*Plugin) Help

func (p *Plugin) Help(name string)

func (*Plugin) Install

func (p *Plugin) Install() error

func (*Plugin) Run

func (p *Plugin) Run(cliConnection cfplugin.CliConnection, args []string)

type UI

type UI struct {
	Out       io.Writer
	Err       io.Writer
	In        io.Reader
	ErrIsTerm bool
}

func (*UI) Error

func (u *UI) Error(err error)

func (*UI) Output

func (u *UI) Output(format string, a ...interface{})

func (*UI) Prompt

func (u *UI) Prompt(message string) string

func (*UI) Warn

func (u *UI) Warn(format string, a ...interface{})

type UserInterface

type UserInterface interface {
	Prompt(prompt string) string
	Output(format string, a ...interface{})
	Warn(format string, a ...interface{})
	Error(err error)
}