input

Documentation

Index

• Constants
• Variables
• func Continue()
• type Options
• type Query
• type UI
  • func DefaultUI() *UI
  • func (u *UI) AddQueries(q ...*Query)
  • func (i *UI) Ask(q *Query) (string, error)
  • func (i *UI) AskStringVar(q *Query, v *string) error
  • func (u *UI) Enquire()
  • func (i *UI) Select(q *Query) (string, error)
  • func (u *UI) SingleQuery(q string, opts *Options) *Query
• type ValidateFunc

Constants

const LineSep = "\n"

LineSep is the separator for windows or unix systems

Variables

var (
	// Errs are error returned by input functions.
	// It's useful for handling error from outside of input functions.
	ErrEmpty       = errors.New("default value is not provided but input is empty")
	ErrNotNumber   = errors.New("input must be number")
	ErrOutOfRange  = errors.New("input is out of range")
	ErrInterrupted = errors.New("interrupted")
)

Functions

func Continue

func Continue()

Types

type Options

type Options struct {
	Key      string
	Options  []string
	Default  string
	Loop     bool
	Required bool
	// contains filtered or unexported fields
}

type Query

type Query struct {
	Q    string
	Opts *Options
}

type UI

type UI struct {
	Queries []*Query
	Writer  io.Writer
	Reader  io.Reader
	// contains filtered or unexported fields
}

func DefaultUI

func DefaultUI() *UI

DefaultUI returns default UI. It outputs to stdout and intputs from stdin.

func (*UI) AddQueries

func (u *UI) AddQueries(q ...*Query)

func (*UI) Ask

func (i *UI) Ask(q *Query) (string, error)

func (*UI) AskStringVar

func (i *UI) AskStringVar(q *Query, v *string) error

func (*UI) Enquire

func (u *UI) Enquire()

func (*UI) Select

func (i *UI) Select(q *Query) (string, error)

func (*UI) SingleQuery

func (u *UI) SingleQuery(q string, opts *Options) *Query

type ValidateFunc

type ValidateFunc func(string) error