console

Documentation

Index

• Constants
• Variables
• type Config
• type Console
  • func New(config Config) (*Console, error)
  • func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, string)
  • func (c *Console) Evaluate(statement string) error
  • func (c *Console) Execute(path string) error
  • func (c *Console) Interactive()
  • func (c *Console) Stop(graceful bool) error
  • func (c *Console) Welcome()
• type UserPrompter
• type WordCompleter

Constants

const DefaultPrompt = "> "

const HistoryFile = "history"

Variables

var Stdin = newTerminalPrompter()

Types

type Config

type Config struct {
	DataDir  string
	DocRoot  string
	Client   *rpc.Client
	Prompt   string
	Prompter UserPrompter
	Printer  io.Writer
	Preload  []string
}

type Console

type Console struct {
	// contains filtered or unexported fields
}

func New

func New(config Config) (*Console, error)

func (*Console) AutoCompleteInput

func (c *Console) AutoCompleteInput(line string, pos int) (string, []string, string)

func (*Console) Evaluate

func (c *Console) Evaluate(statement string) error

func (*Console) Execute

func (c *Console) Execute(path string) error

func (*Console) Interactive

func (c *Console) Interactive()

func (*Console) Stop

func (c *Console) Stop(graceful bool) error

func (*Console) Welcome

func (c *Console) Welcome()

type UserPrompter

type UserPrompter interface {
	PromptInput(prompt string) (string, error)

	PromptPassword(prompt string) (string, error)

	PromptConfirm(prompt string) (bool, error)

	SetHistory(history []string)

	AppendHistory(command string)

	ClearHistory()

	SetWordCompleter(completer WordCompleter)
}

type WordCompleter

type WordCompleter func(line string, pos int) (string, []string, string)