term_view

Documentation

Index

• Constants
• type FdWriter
• type ProgressLog
  • func NewPLog(cr *wss.ConnRecord) *ProgressLog
  • func (p *ProgressLog) SetLogBuffer(r *wss.ConnRecord)
  • func (p *ProgressLog) Write(buf []byte) (int, error)
• type Writer
  • func NewWriter() *Writer
  • func (w *Writer) ClearLines()
  • func (w *Writer) Flush(onLinesCleared func() error) error
  • func (w *Writer) NormalWrite(buf []byte) (n int, err error)
  • func (w *Writer) Write(buf []byte) (n int, err error)

Constants

const ESC = 27

ESC is the ASCII code for escape character

Types

type FdWriter

type FdWriter interface {
	io.Writer
	Fd() uintptr
}

FdWriter is a writer with a file descriptor.

type ProgressLog

type ProgressLog struct {
	Writer *Writer // terminal writer  todo defer Flush
	// contains filtered or unexported fields
}

func NewPLog

func NewPLog(cr *wss.ConnRecord) *ProgressLog

func (*ProgressLog) SetLogBuffer

func (p *ProgressLog) SetLogBuffer(r *wss.ConnRecord)

set progress log(connection table), the connection table is write into p.Write (p.Write is a bytes buffer, only really output to screen when calling Flush).

func (*ProgressLog) Write

func (p *ProgressLog) Write(buf []byte) (int, error)

write interface: write buffer data directly to stdout.

type Writer

type Writer struct {
	OutDev io.Writer
	// contains filtered or unexported fields
}

Writer will updates the terminal when flush is called.

func NewWriter

func NewWriter() *Writer

NewWriter returns a new Writer with default values

func (*Writer) ClearLines

func (w *Writer) ClearLines()

wrapper function to call clearLines on different platform

func (*Writer) Flush

func (w *Writer) Flush(onLinesCleared func() error) error

Flush writes to the out and resets the buffer.

func (*Writer) NormalWrite

func (w *Writer) NormalWrite(buf []byte) (n int, err error)

Write write contents to the writer's io writer.

func (*Writer) Write

func (w *Writer) Write(buf []byte) (n int, err error)