console

Documentation

Index

• func Exit(code int, msg string, w ...io.Writer)
• func ExitWithError(err Error, w ...io.Writer)
• func Exitf(code int, tmpl string, args ...any)
• func ExitfOn(code int, tmpl string, w io.Writer, args ...any)
• func FocusedElement(c Cycler) string
• func HistoryFilter(h History, r *regexp.Regexp) (out []string)
• func HistoryFilterMotive(h History, motive string, insensitive ...bool) (out []string)
• func HistoryFilterPrefix(h History, prefix string, insensitive ...bool) (out []string)
• func HistoryFilterSuffix(h History, suffix string, insensitive ...bool) (out []string)
• func HistoryList(h History) (out []string)
• func IsFocused(c Cycler) bool
• func Unfocus(h History)
• type Console
• type ConvFunc
• type Cycler
• type Error
• type History
• type ParsedPromptFunc
  • func MultiplePrompt[T any](sp PromptFunc, conv ConvFunc[T], t ...scanner.Tokenizer) ParsedPromptFunc[[]T]
  • func ParsedPrompt[T any](sp PromptFunc, conv ConvFunc[T]) ParsedPromptFunc[T]
  • func PromptBool(sp PromptFunc) ParsedPromptFunc[bool]
  • func PromptFloat(sp PromptFunc) ParsedPromptFunc[float64]
  • func PromptInt(sp PromptFunc) ParsedPromptFunc[int]
  • func PromptSlice(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]string]
  • func PromptSliceBool(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]bool]
  • func PromptSliceFloat(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]float64]
  • func PromptSliceInt(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]int]
  • func PromptSliceUint(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]uint]
  • func PromptUint(sp PromptFunc) ParsedPromptFunc[uint]
• type PromptFunc
  • func PromptOf(p Prompter) PromptFunc
• type Prompter

Functions

func Exit

func Exit(code int, msg string, w ...io.Writer)

Exit quitte le programme en affichant une erreur. Si aucun descripteur n’est fourni, le message d’erreur est écrit sur la sortie erreur standard.

func ExitWithError

func ExitWithError(err Error, w ...io.Writer)

ExitWithError quitte le programme en utilisant l’erreur fournie.

func Exitf

func Exitf(code int, tmpl string, args ...any)

Exitf agit comme ExitfOn sur la sortie erreur standard.

func ExitfOn

func ExitfOn(code int, tmpl string, w io.Writer, args ...any)

ExitfOn agit comme Exit mais mais formate le message

func FocusedElement

func FocusedElement(c Cycler) string

FocusedElement retourne l’élément pointé par le cycler.

func HistoryFilter

func HistoryFilter(h History, r *regexp.Regexp) (out []string)

HistoryFilter retourne les entrées de l’historique vérifiant la regexp donnée.

func HistoryFilterMotive

func HistoryFilterMotive(h History, motive string, insensitive ...bool) (out []string)

HistoryFilterMotive retourne les entrées de l’historique contenant le motif donnée. Il est possible de faire une recherche insensible à la casse.

func HistoryFilterPrefix

func HistoryFilterPrefix(h History, prefix string, insensitive ...bool) (out []string)

HistoryFilterPrefix retourne les entrées de l’historique commençant le préfixe donné. Il est possible de faire une recherche insensible à la casse.

func HistoryFilterSuffix

func HistoryFilterSuffix(h History, suffix string, insensitive ...bool) (out []string)

HistoryFilterSuffix retourne les entrées de l’historique terminant par le suffixe donné. Il est possible de faire une recherche insensible à la casse.

func HistoryList

func HistoryList(h History) (out []string)

HistoryList retourne le contenu de l’historique

func IsFocused

func IsFocused(c Cycler) bool

IsFocused retourne vrai si le cycler pointe sur un élément existant.

func Unfocus

func Unfocus(h History)

Unfocus enlève le pointage de l’historique.

Types

type Console

type Console interface {
	Prompter
	LoadHistory(io.Reader) (int, error)
	SaveHistory(io.Writer) (int, error)
	ClearHistory()
	AppendHistory(string)
}

Console est un prompt avec gestion de l’historique

type ConvFunc

type ConvFunc[T any] func(string) (T, error)

ConvFunc est une fonction qui convertit une chaîne de caractère en un type donné.

type Cycler

type Cycler interface {
	Len() int
	Cursor() int
	Index(int) string
	SetCursor(int) bool
	Append(string)
	Clear()
	Next() bool
	Prev() bool
}

Cycler est une interface permettant de gérer des choix

type Error

type Error interface {
	Error() string
	Code() int
}

Error représente une erreur terminal

type History

type History interface {
	Cycler
	Read(io.Reader) (int, error)
	Write(io.Writer) (int, error)
}

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

type ParsedPromptFunc

type ParsedPromptFunc[T any] func(string) (T, error)

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

func MultiplePrompt

func MultiplePrompt[T any](
	sp PromptFunc,
	conv ConvFunc[T],
	t ...scanner.Tokenizer,
) ParsedPromptFunc[[]T]

MultiplePrompt transforme un prompt en prompt de valeurs multiples. Si aucun tokenizer n’est fourni, il considère la chaîne globale comme des mots séparés par des blancs.

func ParsedPrompt

func ParsedPrompt[T any](sp PromptFunc, conv ConvFunc[T]) ParsedPromptFunc[T]

ParsedPrompt transforme un prompt en prompt de donnée parsée.

func PromptBool

func PromptBool(sp PromptFunc) ParsedPromptFunc[bool]

PromptBool transforme un prompt en prompt de booléen.

Valeurs autorisée : - true : O(ui), Y(es), t(rue), 1, on - false : N(on), f(alse), 0, off La valeur est insensible à la casse.

func PromptFloat

func PromptFloat(sp PromptFunc) ParsedPromptFunc[float64]

PromptFloat transforme un prompt en prompt de nombre décimal.

func PromptInt

func PromptInt(sp PromptFunc) ParsedPromptFunc[int]

PromptInt transforme un prompt en prompt d’entier.

func PromptSlice

func PromptSlice(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]string]

PromptSlice transform un prompt en prompt de slice de strings.

func PromptSliceBool

func PromptSliceBool(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]bool]

PromptSliceBool transform un prompt en prompt de slice de booléens.

func PromptSliceFloat

func PromptSliceFloat(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]float64]

PromptSliceFloat transform un prompt en prompt de slice de décimaux.

func PromptSliceInt

func PromptSliceInt(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]int]

PromptSliceInt transform un prompt en prompt de slice d’entiers.

func PromptSliceUint

func PromptSliceUint(sp PromptFunc, t ...scanner.Tokenizer) ParsedPromptFunc[[]uint]

PromptSliceUint transform un prompt en prompt de slice d’entiers non signés.

func PromptUint

func PromptUint(sp PromptFunc) ParsedPromptFunc[uint]

PromptUint transforme un prompt en prompt d’entier non signé.

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

PromptOf transforme un prompter en fonction promptable.

type Prompter

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

Prompter est une interface pour représenter un prompt