README
¶
From https://github.com/restic/restic/tree/master/internal/ui/termstatus.
git remote add upstream [email protected]:restic/restic.git
git filter-repo --subdirectory-filter internal/ui/termstatus
Documentation
¶
Index ¶
- func Assert(tb testing.TB, condition bool, msg string, v ...interface{})
- func CanUpdateStatus(fd uintptr) bool
- func Equals(tb testing.TB, exp, act interface{}, msgs ...string)
- func IsProcessBackground(fd uintptr) bool
- func OK(tb testing.TB, err error)
- func Quote(line string) string
- func Truncate(s string, w int) string
- func WrapStdio(term *Terminal) (stdout, stderr io.WriteCloser)
- type Terminal
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CanUpdateStatus ¶
CanUpdateStatus returns true if status lines can be printed, the process output is not redirected to a file or pipe.
func Equals ¶
Equals fails the test if exp is not equal to act. msg is optional message to be printed, first param being format string and rest being arguments.
func IsProcessBackground ¶
IsProcessBackground reports whether the current process is running in the background. fd must be a file descriptor for the terminal.
func Quote ¶
Quote lines with funny characters in them, meaning control chars, newlines, tabs, anything else non-printable and invalid UTF-8.
This is intended to produce a string that does not mess up the terminal rather than produce an unambiguous quoted string.
func Truncate ¶
Truncate s to fit in width (number of terminal cells) w. If w is negative, returns the empty string.
func WrapStdio ¶
func WrapStdio(term *Terminal) (stdout, stderr io.WriteCloser)
WrapStdio returns line-buffering replacements for os.Stdout and os.Stderr. On Close, the remaining bytes are written, followed by a line break.
Types ¶
type Terminal ¶
type Terminal struct {
// contains filtered or unexported fields
}
Terminal is used to write messages and display status lines which can be updated. When the output is redirected to a file, the status lines are not printed.
func New ¶
New returns a new Terminal for wr. A goroutine is started to update the terminal. It is terminated when ctx is cancelled. When wr is redirected to a file (e.g. via shell output redirection) or is just an io.Writer (not the open *os.File for stdout), no status lines are printed. The status lines and normal output (via Print/Printf) are written to wr, error messages are written to errWriter. If disableStatus is set to true, no status messages are printed even if the terminal supports it.
func (*Terminal) CanUpdateStatus ¶
CanUpdateStatus return whether the status output is updated in place.
Source Files