README
¶
go-inquote
A library that translates runes into their representation inside a quoted string, for the Go programming language.
For example
runevalue10(which is the "line feed" character) becomes\nrunevalue31(which is the "unit separator" character) becomes\x1f- etc
And of course, something like rune value 65 (which is the "uppercase A" character) stays as A.
Documention
Online documentation, which includes examples, can be found at: http://godoc.org/github.com/reiver/go-inquote
Documentation
¶
Overview ¶
Package inquote translates runes into their representation inside a quoted string,
For example, rune value 10 (which is the "line feed" character) becomes \n
Also, for example, rune value 31 (which is the "unit separator" character) becomes \x1f
Sample Code AppendRune
r1 := rune(11) // This is the Vertical Tab character. Which could also be written '\v'
r2 := rune(84) // This is the Uppercase T character. Which could also be written 'T'
r2 := rune(30) // This is the Row Separator character. Which could also be written '\x1e'
p := []byte{}
p = inquote.AppendRune(p, r1)
// p == []byte{ rune(92), rune(118) } == []byte{'\\', 'v'}
p = inquote.AppendRune(p, r2)
// p == []byte{ rune(92), rune(118), rune(84) } == []byte{'\\', 'v', 'T'}
p = inquote.AppendRune(p, r3)
// p == []byte{ rune(92), rune(118), rune(84), rune(92), rune(120), rune(49), rune(101) } == []byte{'\\', 'v', 'T', '\\', 'x', '1', 'e'}
Sample Code WriteRune
var buffer bytes.Buffer
var writer io.Writer
writer = &buffer
r1 := rune(11) // This is the Vertical Tab character. Which could also be written '\v'
r2 := rune(84) // This is the Uppercase T character. Which could also be written 'T'
r2 := rune(30) // This is the Row Separator character. Which could also be written '\x1e'
var n int
var err error
sum := 0
n, err = inquote.WriteRune(writer, r1)
if nil != err {
return err
}
sum += n
n, err = inquote.WriteRune(writer, r2)
if nil != err {
return err
}
sum += n
n, err = inquote.WriteRune(writer, r3)
if nil != err {
return err
}
sum += n
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AppendRune ¶
AppendRune appends the string-literal-encoding of a rune to the []byte `p`.
Many runes stay as the are.
For example, rune(55), rune(65), and rune(100) would stay as is, since they are the runes '7', 'A' and 'd' respectively.
However, some runes change.
For example, rune(13), rune(21), rune(27), and rune(92) would change, since they are the rune runes '\r', '\x15', '\x1b', and '\\' respectively.
func DecodeRune ¶
DecodeRune decodes a string-literal-encoding of a rune from the beginning of `p`.
It returns the value of the return, and the number of bytes the rune occupied.
So, for example, one code do decoding with code such as:
var p []byte
p = ...
for 0 < len(p) {
r, n, err := inquote.DecodeRune(p)
if nil != err {
if io.EOF == err {
break
}
return err
}
fmt.Printf("RUNE: %d\n", r)
p = p[n:]
}
func WriteRune ¶
WriteRune writes the string-literal-encoding of a rune to the io.Writer `w`.
Many runes stay as the are.
For example, rune(55), rune(65), and rune(100) would stay as is, since they are the runes '7', 'A' and 'd' respectively.
However, some runes change.
For example, rune(13), rune(21), rune(27), and rune(92) would change, since they are the rune runes '\r', '\x15', '\x1b', and '\\' respectively.
Types ¶
This section is empty.
Source Files