display

Documentation

Overview

Package display prints and receives input from the console.

Index

• func Action(t TLogger, action string)
• func Banner(t TLogger, lines ...string)
• func Menu(msg string, options ...string) int
• func ReadLine() string
• func ReaderStarted() bool
• func StartReader() error
• func StopReader() error
• type TLogger

Functions

func Action

func Action(t TLogger, action string)

Action displays the specified action message. If t is not nil, the message is associated with the current test case.

func Banner

func Banner(t TLogger, lines ...string)

Banner displays a banner message with the specified lines. If t is not nil, the message is associated with the current test case.

func Menu

func Menu(msg string, options ...string) int

Menu displays a menu with the specified message and list of options and returns the 1-indexed option number that the user selected.

func ReadLine

func ReadLine() string

ReadLine reads a line of user input. Exits fatally if the reader has not been started.

func ReaderStarted

func ReaderStarted() bool

ReaderStarted returns whether or not the reader has started.

func StartReader

func StartReader() error

StartReader starts a stdin reader.

func StopReader

func StopReader() error

StopReader stops the reader. Noop if it hasn't started.

Types

type TLogger

type TLogger interface {
	Helper()
	Log(...any)
}

TLogger is the subset of testing.T needed for logging.

var (
	// MainT is used for logging in TestMain.
	MainT TLogger = &mainLogger{}
)