prompt

Documentation

Overview

Package rwi : Reader/Writer Interface for command-line

These codes are licensed under CC0. http://creativecommons.org/publicdomain/zero/1.0/

Package rwi : Reader/Writer Interface for command-line

These codes are licensed under CC0. http://creativecommons.org/publicdomain/zero/1.0/

Index

• type Errno
  • func (n Errno) Error() string
• type OptFunc
  • func WithHeaderMessage(s string) OptFunc
  • func WithPromptString(s string) OptFunc
• type Prompt
  • func New(rw *rwi.RWI, function func(string) (string, error), opts ...OptFunc) *Prompt
  • func (p *Prompt) IsTerminal() bool
  • func (p *Prompt) Once() error
  • func (p *Prompt) Run() error

Types

type Errno

type Errno int

Errno is error number for CVSS

const (
	ErrTerminate Errno = iota + 1
	ErrNotTerminal
)

func (Errno) Error

func (n Errno) Error() string

type OptFunc

type OptFunc func(*Prompt)

OptFunc is self-referential function for functional options pattern

func WithHeaderMessage

func WithHeaderMessage(s string) OptFunc

WithHeaderMessage returns function for setting Reader

func WithPromptString

func WithPromptString(s string) OptFunc

WithPromptString returns function for setting Reader

type Prompt

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

Prompt is a class for interactive mode in CUI shell

func New

func New(rw *rwi.RWI, function func(string) (string, error), opts ...OptFunc) *Prompt

New returns new Prompt instance

func (*Prompt) IsTerminal

func (p *Prompt) IsTerminal() bool

IsTerminal returns true if running in terminal

func (*Prompt) Once

func (p *Prompt) Once() error

Once function starts interactive mode (one round).

func (*Prompt) Run

func (p *Prompt) Run() error

Run function starts interactive mode.