prompt

Documentation

Index

• func Blanked(src []byte) ([]byte, []byte)
• func CaretNotation(src []byte) ([]byte, []byte)
• func Masked(src []byte) ([]byte, []byte)
• type SignalError
  • func (se SignalError) Error() string
  • func (se SignalError) Signal() int
• type Terminal
  • func NewTerminal() (*Terminal, error)
  • func (t *Terminal) Close() error
  • func (t *Terminal) ContextReader(ctx context.Context) (io.ReadCloser, error)
  • func (t *Terminal) GetSize() (width, height int, err error)
  • func (t *Terminal) MakeRaw() error
  • func (t *Terminal) Read(p []byte) (int, error)
  • func (t *Terminal) ReadCustom(ctx context.Context, prompt string, transform TransformFunc) ([]byte, error)
  • func (t *Terminal) ReadLine(ctx context.Context, prompt string) ([]byte, error)
  • func (t *Terminal) ReadNoEcho(ctx context.Context, prompt string) ([]byte, error)
  • func (t *Terminal) ReadPassword(ctx context.Context, prompt string) ([]byte, error)
  • func (t *Terminal) Restore() error
  • func (t *Terminal) Write(p []byte) (int, error)
• type TransformFunc

Functions

func Blanked

func Blanked(src []byte) ([]byte, []byte)

Blanked displays nothing.

func CaretNotation

func CaretNotation(src []byte) ([]byte, []byte)

CaretNotation displays control characters in caret notation.

func Masked

func Masked(src []byte) ([]byte, []byte)

Masked displays all characters as asterisks.

Types

type SignalError

type SignalError syscall.Signal

SignalError indicates that the operation was interrupted by a signal.

func (SignalError) Error

func (se SignalError) Error() string

func (SignalError) Signal

func (se SignalError) Signal() int

Signal returns the signal number.

type Terminal

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

Terminal represents a terminal.

func NewTerminal

func NewTerminal() (*Terminal, error)

NewTerminal opens a terminal.

func (*Terminal) Close

func (t *Terminal) Close() error

Close closes the terminal.

func (*Terminal) ContextReader

func (t *Terminal) ContextReader(ctx context.Context) (io.ReadCloser, error)

ContextReader returns an io.ReadCloser that cancels the Read operation when context's Done channel is closed.

func (*Terminal) GetSize

func (t *Terminal) GetSize() (width, height int, err error)

GetSize returns the visible dimensions of the given terminal.

func (*Terminal) MakeRaw

func (t *Terminal) MakeRaw() error

MakeRaw puts the terminal into raw mode.

func (*Terminal) Read

func (t *Terminal) Read(p []byte) (int, error)

Read reads up to len(p) bytes from the terminal.

func (*Terminal) ReadCustom

func (t *Terminal) ReadCustom(ctx context.Context, prompt string, transform TransformFunc) ([]byte, error)

ReadCustom reads a line of input from the terminal with custom transform function.

func (*Terminal) ReadLine

func (t *Terminal) ReadLine(ctx context.Context, prompt string) ([]byte, error)

ReadLine reads a line of input from the terminal.

func (*Terminal) ReadNoEcho

func (t *Terminal) ReadNoEcho(ctx context.Context, prompt string) ([]byte, error)

ReadNoEcho reads a line of input from the terminal without local echo.

func (*Terminal) ReadPassword

func (t *Terminal) ReadPassword(ctx context.Context, prompt string) ([]byte, error)

ReadPassword reads a line of input from the terminal with masking.

func (*Terminal) Restore

func (t *Terminal) Restore() error

Restore restores the terminal to the state prior to calling MakeRaw.

func (*Terminal) Write

func (t *Terminal) Write(p []byte) (int, error)

Write writes len(p) bytes to the terminal.

type TransformFunc

type TransformFunc func(src []byte) (disp, bs []byte)

TransformFunc transforms src into its display form and a sequence of backspaces for deleting it.