package vtclean

Import Path
	github.com/lunixbochs/vtclean (on go.dev)

Dependency Relation
	imports 5 packages, and imported by one package

Involved Source Files

	      io.go
	      line.go
	      vtclean.go
Package-Level Type Names (total 4, none are exported)

	/* sort exporteds by: alphabet | popularity */
	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type char (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			char byte
			vt100 []byte
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func chars(p []byte) []char

	 type lineEdit (struct)

		Fields (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			buf []char
			pos int
			size int
			vt100 []byte
		Methods (total 11, all are exported)
			(*T) Bytes() []byte
			(*T) Clear()
			(*T) ClearLeft()
			(*T) ClearRight()
			(*T) Delete(n int)
			(*T) Insert(p []byte)
			(*T) Move(x int)
			(*T) MoveAbs(x int)
			(*T) String() string
			(*T) Vt100(p []byte)
			(*T) Write(p []byte)
		Implements (at least 4, in which 1 are exported)
			*T : fmt.Stringer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*T : context.stringer
			*T : os/signal.stringer
			*T : runtime.stringer
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func newLineEdit(length int) *lineEdit

	 type reader (struct)

		Fields (total 4, in which 1 are exported)
			Reader io.Reader
			/* 3 unexporteds ... *//* 3 unexporteds: */
			buf []byte
			color bool
			scanner *bufio.Scanner
		Methods (total 3, in which 1 are exported)
			(*T) Read(p []byte) (int, error)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) fill(p []byte) int
			(*T) scan() bool
		Implements (at least one exported)
			*T : io.Reader

	 type writer (struct)

		Fields (total 3, in which 1 are exported)
			Writer io.Writer
			/* 2 unexporteds ... *//* 2 unexporteds: */
			buf []byte
			color bool
		Methods (total 2, both are exported)
			(*T) Close() error
			(*T) Write(p []byte) (int, error)
		Implements (at least 3, all are exported)
			*T : io.Closer
			*T : io.WriteCloser
			*T : io.Writer


Package-Level Functions (total 5, in which 3 are exported)

	 func Clean(line string, color bool) string
	 func NewReader(r io.Reader, color bool) io.Reader
	 func NewWriter(w io.Writer, color bool) io.WriteCloser
	/* 2 unexporteds ... *//* 2 unexporteds: */
	 func chars(p []byte) []char
	 func newLineEdit(length int) *lineEdit
Package-Level Variables (total 3, none are exported)

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var vt100exc *regexp.Regexp
	  var vt100long *regexp.Regexp
		this is to handle the RGB escape generated by `tput initc 1 500 500 500`

	  var vt100re *regexp.Regexp
		regex based on ECMA-48:
		1. optional:
		   one of [ or ]
		   any amount of 0x30-0x3f
		   any amount of 0x20-0x2f
		3. exactly one 0x40-0x7e

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.