prompt

Documentation

Index

• func ToSelect(options InputOptions) (int, error)
• type InputError
• type InputHelper
  • func (ih InputHelper) GetData() string
  • func (ih InputHelper) PrintAfterMessage()
  • func (ih InputHelper) PrintBeforeMessage()
  • func (ih InputHelper) PrintOptions()
  • func (ih *InputHelper) ReadInput() error
• type InputOptions
• type InputType

Functions

func ToSelect

func ToSelect(options InputOptions) (int, error)

ToSelect prompts the user to select an option from the provided `options.Options` argument. On success, returns the selected index. Returns `ErrorSkipped` if the user indicated to skip, returns `ErrorInput` on input validation errors, returns `ErrorSystem` on system errors

Types

type InputError

type InputError int

const (
	ErrorSkipped InputError = -1
	ErrorInput   InputError = -2
	ErrorSystem  InputError = -3
)

type InputHelper

type InputHelper InputOptions

InputHelper implements helper functions over the InputOptions structure

func (InputHelper) GetData

func (ih InputHelper) GetData() string

GetData retrieves the read input

func (InputHelper) PrintAfterMessage

func (ih InputHelper) PrintAfterMessage()

PrintAfterMessage prints the message to be displayed after the possible options have been printed

func (InputHelper) PrintBeforeMessage

func (ih InputHelper) PrintBeforeMessage()

PrintBeforeMessage prints the message to be displayed before the possible options are printed

func (InputHelper) PrintOptions

func (ih InputHelper) PrintOptions()

PrintOptions prints the possible options for the user to select

func (*InputHelper) ReadInput

func (ih *InputHelper) ReadInput() error

ReadInput reads in a user's input

type InputOptions

type InputOptions struct {
	BeforeMessage     string
	AfterMessage      string
	SerializedOptions []string
	Type              InputType
	Reader            io.Reader
	// contains filtered or unexported fields
}

type InputType

type InputType string

const (
	TypeInt    InputType = "int"
	TypeUInt   InputType = "uint"
	TypeString InputType = "string"
	TypeBool   InputType = "bool"
)