minterm

Documentation

Overview

Package minterm implements minimal terminal functions.

Index

• Variables
• type MinTerm
  • func New() (*MinTerm, error)
  • func (m *MinTerm) Prompt(prompt string) (string, error)
  • func (m *MinTerm) PromptPassword(prompt string) (string, error)
  • func (m *MinTerm) Shutdown() error
  • func (m *MinTerm) Size() (int, int)
  • func (m *MinTerm) Write(s string) error
• type WindowsReadWriter
  • func (rw WindowsReadWriter) Read(p []byte) (n int, err error)
  • func (rw WindowsReadWriter) Write(p []byte) (n int, err error)

Variables

var ErrPromptInterrupted = errors.New("prompt interrupted")

Types

type MinTerm

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

MinTerm is a minimal terminal interface.

func New

func New() (*MinTerm, error)

New creates a new MinTerm and opens the terminal file. Any errors that happen while opening or getting the terminal size are returned.

func (*MinTerm) Prompt

func (m *MinTerm) Prompt(prompt string) (string, error)

Prompt gets a line of input from the terminal. It displays the text in the prompt parameter first.

func (*MinTerm) PromptPassword

func (m *MinTerm) PromptPassword(prompt string) (string, error)

PromptPassword gets a line of input from the terminal, but nothing is echoed to the terminal to hide the text.

func (*MinTerm) Shutdown

func (m *MinTerm) Shutdown() error

Shutdown closes the terminal.

func (*MinTerm) Size

func (m *MinTerm) Size() (int, int)

Size returns the width and height of the terminal.

func (*MinTerm) Write

func (m *MinTerm) Write(s string) error

Write writes a string to the terminal.

type WindowsReadWriter

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

terminal takes io.ReadWriter, so for windows we mash stdin and stdout back together with this.

func (WindowsReadWriter) Read

func (rw WindowsReadWriter) Read(p []byte) (n int, err error)

func (WindowsReadWriter) Write

func (rw WindowsReadWriter) Write(p []byte) (n int, err error)