console

Documentation

Index

• func Exit(code int, msg string)
• func Exitf(code int, form string, args ...interface{})
• func Question(question string, def string) (result string)
• func QuestionBool(question string, def bool) (result bool)
• func QuestionChoice(question string, def string, choices []string) (result string)
• func QuestionInt(question string, def int) (result int)
• func Read(prompt string) (result string, err error)
• func ReadBool(prompt string) (result bool, err error)
• func ReadInt(prompt string) (result int, err error)
• func ReadSlice(prompt string, t ...scanner.Tokenizer) (result []string, err error)
• type AutoCompleteTerminal
• type CompleteFunc
• type CompleteTerminal
• type ConvertFunc
• type Error
  • func NewError(code int, msg string) *Error
  • func NewErrorf(code int, form string, args ...interface{}) *Error
  • func (e *Error) Code() int
  • func (e *Error) Error() string
  • func (e *Error) Exit(wtr ...io.Writer)
• type History
• type PromptFunc
  • func PromptOf(p Prompter) PromptFunc
  • func (pf PromptFunc) Bool(p string) (result bool, err error)
  • func (pf PromptFunc) Default(p string, value interface{}, def interface{}, conv ConvertFunc, ...) error
  • func (pf PromptFunc) Int(p string) (result int, err error)
  • func (pf PromptFunc) Slice(p string, t ...scanner.Tokenizer) (result []string, err error)
• type Prompter
• type Terminal
  • func New(historyOnError ...bool) Terminal
• type ValidFunc
• type WordCompleteFunc
• type WordCompleteTerminal

Functions

func Exit

func Exit(code int, msg string)

func Exitf

func Exitf(code int, form string, args ...interface{})

func Question

func Question(question string, def string) (result string)

func QuestionBool

func QuestionBool(question string, def bool) (result bool)

func QuestionChoice

func QuestionChoice(question string, def string, choices []string) (result string)

func QuestionInt

func QuestionInt(question string, def int) (result int)

func Read

func Read(prompt string) (result string, err error)

func ReadBool

func ReadBool(prompt string) (result bool, err error)

func ReadInt

func ReadInt(prompt string) (result int, err error)

func ReadSlice

func ReadSlice(prompt string, t ...scanner.Tokenizer) (result []string, err error)

Types

type AutoCompleteTerminal

type AutoCompleteTerminal interface {
	Terminal
	SetCompleter(CompleteFunc)
	SetWordCompleter(WordCompleteFunc)
}

AutoCompleteTerminal est un prompt implémentant l’autocomplétion de lignes et de mots

type CompleteFunc

type CompleteFunc func(line string) []string

CompleteFunc est une fonction permettant de compléter une ligne de commandes

type CompleteTerminal

type CompleteTerminal interface {
	Terminal
	SetCompleter(CompleteFunc)
}

CompleteTerminal est un prompt implémentant l’autocomplétion de lignes

type ConvertFunc

type ConvertFunc func(string) (interface{}, error)

ConvertFunc est une fonction qui affiche une invite de commande et retourne la saisie parsée

type Error

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

Error représente une sortie de commande UNIX

func NewError

func NewError(code int, msg string) *Error

func NewErrorf

func NewErrorf(code int, form string, args ...interface{}) *Error

func (*Error) Code

func (e *Error) Code() int

func (*Error) Error

func (e *Error) Error() string

func (*Error) Exit

func (e *Error) Exit(wtr ...io.Writer)

type History

type History interface {
	AppendHistory(string)
	ClearHistory()
	ReadHistory(io.Reader) (int, error)
	WriteHistory(io.Writer) (int, error)
}

History est une interface pour gérer l’historique des commandes saisies

type PromptFunc

type PromptFunc func(string) (string, error)

PromptFunc est une fonction qui affiche une invite de commande et retourne la saisie brute

func PromptOf

func PromptOf(p Prompter) PromptFunc

func (PromptFunc) Bool

func (pf PromptFunc) Bool(p string) (result bool, err error)

Bool lance une invite de commande attendant un booléen

func (PromptFunc) Default

func (pf PromptFunc) Default(p string, value interface{}, def interface{}, conv ConvertFunc, valid ValidFunc) error

Slice lance une invite de commande attendant une réponse optionnelle

func (PromptFunc) Int

func (pf PromptFunc) Int(p string) (result int, err error)

Int lance une invite de commande attendant un entier

func (PromptFunc) Slice

func (pf PromptFunc) Slice(p string, t ...scanner.Tokenizer) (result []string, err error)

Slice lance une invite de commande attendant une liste d’arguments

type Prompter

type Prompter interface {
	Prompt(string) (string, error)
}

Prompter est une interface pour représenter un prompt

type Terminal

type Terminal interface {
	Prompter
	History
}

Terminal est un prompt stockant l’historique des saisies

func New

func New(historyOnError ...bool) Terminal

New retourne un terminal élémentaire Si historyOnError, seules les commandes sans erreur sont stockées dans l’historique

type ValidFunc

type ValidFunc func(interface{}) bool

type WordCompleteFunc

type WordCompleteFunc func(line string, pos int) (head string, candidates []string, tail string)

WordCompleteFunc est une fonction permettant de compléter un arguement dans une ligne de commande pos est la position actuelle du curseur head et tail sont la partie à gauche et à droite de l’argument à compléter candidates est la liste des choix possibles pour compléter l’argument

type WordCompleteTerminal

type WordCompleteTerminal interface {
	Terminal
	SetWordCompleter(WordCompleteFunc)
}

WordCompleteTerminal est un prompt implémentant l’autocomplétion de mots