import "github.com/gosuri/uilive"
Package uilive provides a writer that live updates the terminal. It provides a buffered io.Writer that is flushed at a timed interval.
Code:
writer := uilive.New() // start listening to updates and render writer.Start() for i := 0; i <= 100; i++ { fmt.Fprintf(writer, "Downloading.. (%d/%d) GB\n", i, 100) time.Sleep(time.Millisecond * 5) } fmt.Fprintln(writer, "Finished: Downloaded 100GB") writer.Stop() // flush and stop rendering
doc.go terminal_size.go writer.go writer_posix.go
const ESC = 27
ESC is the ASCII code for escape character
ErrClosedPipe is the error returned when trying to writer is not listening
Out is the default output writer for the Writer
var RefreshInterval = time.Millisecond
RefreshInterval is the default refresh interval to update the ui
FdWriter is a writer with a file descriptor.
type Writer struct { // Out is the writer to write to Out io.Writer // RefreshInterval is the time the UI sould refresh RefreshInterval time.Duration // contains filtered or unexported fields }
Writer is a buffered the writer that updates the terminal. The contents of writer will be flushed on a timed interval or when Flush is called.
New returns a new Writer with defaults
Bypass creates an io.Writer which allows non-buffered output to be written to the underlying output
Flush writes to the out and resets the buffer. It should be called after the last call to Write to ensure that any data buffered in the Writer is written to output. Any incomplete escape sequence at the end is considered complete for formatting purposes. An error is returned if the contents of the buffer cannot be written to the underlying output stream
Listen listens for updates to the writer's buffer and flushes to the out provided. It blocks the runtime.
Newline creates an io.Writer which allows buffered output to be written to the underlying output. This enable writing to multiple lines at once.
Start starts the listener in a non-blocking manner
Stop stops the listener that updates the terminal
Write save the contents of buf to the writer b. The only errors returned are ones encountered while writing to the underlying buffer.
Path | Synopsis |
---|---|
example |
Package uilive imports 11 packages (graph) and is imported by 64 packages. Updated 2020-01-03. Refresh now. Tools for package owners.