ansi

README

ansi

Raw ANSI sequence helpers

ANSI Writer

import "github.com/muesli/ansi"

w := ansi.Writer{Forward: os.Stdout}
w.Write([]byte("\x1b[31mHello, world!\x1b[0m"))
w.Close()

Compressor

The ANSI compressor eliminates unnecessary/redundant ANSI sequences.

import "github.com/muesli/ansi/compressor"

w := compressor.Writer{Forward: os.Stdout}
w.Write([]byte("\x1b[31mHello, world!\x1b[0m"))
w.Close()

Documentation

Index

• Constants
• func IsTerminator(c rune) bool
• func PrintableRuneWidth(s string) int
• type Buffer
  • func (w Buffer) PrintableRuneWidth() int
• type Writer
  • func (w *Writer) LastSequence() string
  • func (w *Writer) ResetAnsi()
  • func (w *Writer) RestoreAnsi()
  • func (w *Writer) Write(b []byte) (int, error)

Constants

const Marker = '\x1B'

Functions

func IsTerminator

func IsTerminator(c rune) bool

func PrintableRuneWidth

func PrintableRuneWidth(s string) int

PrintableRuneWidth returns the cell width of the given string.

Types

type Buffer

type Buffer struct {
	bytes.Buffer
}

Buffer is a buffer aware of ANSI escape sequences.

func (Buffer) PrintableRuneWidth

func (w Buffer) PrintableRuneWidth() int

PrintableRuneWidth returns the cell width of all printable runes in the buffer.

type Writer

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

func (*Writer) LastSequence

func (w *Writer) LastSequence() string

func (*Writer) ResetAnsi

func (w *Writer) ResetAnsi()

func (*Writer) RestoreAnsi

func (w *Writer) RestoreAnsi()

func (*Writer) Write

func (w *Writer) Write(b []byte) (int, error)

Write is used to write content to the ANSI buffer.