caret

README

go-caret

Package caret encodes, and decodes caret text (i.e., where ASCII control codes are in caret notation) into UTF-8 text (which may also be ASCII text).

Documention

Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-caret

ANSI Escape Codes

This can be useful for writing, or reading text that contains ANSI escape codes, such as ANSI color codes.

Note that Caret Notation code note have a good way of representing the caret in the output text.

This is a limit in inherent to Caret Notation.

Caret Notation

The mapping from caret notation to control codes is as follows:

^@ ⇒ NUL (0x00)

^A ⇒ SOH (0x01)

^B ⇒ STX (0x02)

^C ⇒ ETX (0x03)

^D ⇒ EOT (0x04)

^E ⇒ ENQ (0x05)

^F ⇒ ACK (0x06)

^G ⇒ BEL (0x07)

^H ⇒ BS  (0x08)

^I ⇒ HT  (0x09)

^J ⇒ LF  (0x0a)

^K ⇒ VT  (0x0b)

^L ⇒ FF  (0x0c)

^M ⇒ CR  (0x0d)

^N ⇒ SO  (0x0e)

^O ⇒ SI  (0x0f)

^P ⇒ DLE (0x10)

^Q ⇒ DC1 (0x11)

^R ⇒ DC2 (0x12)

^S ⇒ DC3 (0x13)

^T ⇒ DC4 (0x14)

^U ⇒ NAK (0x15)

^V ⇒ SYN (0x16)

^W ⇒ ETB (0x17)

^X ⇒ CAN (0x18)

^Y ⇒ EM  (0x19)

^Z ⇒ SUB (0x1a)

^[ ⇒ ESC (0x1b)

^\ ⇒ FS  (0x1c)

^] ⇒ GS  (0x1d)

^^ ⇒ RS	 (0x1e)

^_ ⇒ US	 (0x1f)

^` ⇒ SP  (0x20)

^? ⇒ DEL (0x7f)

Documentation

Overview

Package caret encodes, and decodes caret text (i.e., where ASCII control codes are in caret notation) into UTF-8 text (which may also be ASCII text).

This can be useful for writing, or reading text that contains ANSI escape codes, such as ANSI color codes.

Note that Caret Notation code note have a good way of representing the caret in the output text.

This is a limit in inherent to Caret Notation.

Caret Notation

The mapping from caret notation to control codes is as follows:

^@ ⇒ NUL (0x00)

^A ⇒ SOH (0x01)

^B ⇒ STX (0x02)

^C ⇒ ETX (0x03)

^D ⇒ EOT (0x04)

^E ⇒ ENQ (0x05)

^F ⇒ ACK (0x06)

^G ⇒ BEL (0x07)

^H ⇒ BS  (0x08)

^I ⇒ HT  (0x09)

^J ⇒ LF  (0x0a)

^K ⇒ VT  (0x0b)

^L ⇒ FF  (0x0c)

^M ⇒ CR  (0x0d)

^N ⇒ SO  (0x0e)

^O ⇒ SI  (0x0f)

^P ⇒ DLE (0x10)

^Q ⇒ DC1 (0x11)

^R ⇒ DC2 (0x12)

^S ⇒ DC3 (0x13)

^T ⇒ DC4 (0x14)

^U ⇒ NAK (0x15)

^V ⇒ SYN (0x16)

^W ⇒ ETB (0x17)

^X ⇒ CAN (0x18)

^Y ⇒ EM  (0x19)

^Z ⇒ SUB (0x1a)

^[ ⇒ ESC (0x1b)

^\ ⇒ FS  (0x1c)

^] ⇒ GS  (0x1d)

^^ ⇒ RS	 (0x1e)

^_ ⇒ US	 (0x1f)

^` ⇒ SP  (0x20)

^? ⇒ DEL (0x7f)

Index

• type Decoder
  • func (receiver *Decoder) Write(p []byte) (int, error)

Types

type Decoder

type Decoder struct {
	Writer io.Writer
}

Decoder lets you write text encoded in Caret Notation, and writes the decoded characters to the nested io.Writer.

Example

Here is an example using caret.Decoder

var writer io.Writer

// ...

var caretDecoder caret.Decoder = caret.Decoder{writer}

var caretText = []byte("The "+ "\x1b" +"[34m" +"blue"+ "\x1b" +"[0m"+" text.")

caretDecoder.Write(caretText)

func (*Decoder) Write

func (receiver *Decoder) Write(p []byte) (int, error)