package bytes

Import Path
	bytes (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 10 packages

Involved Source Files

	      buffer.go
	   #d bytes.go
		Package bytes implements functions for the manipulation of byte slices.
		It is analogous to the facilities of the strings package.

	      reader.go
Code Examples

	Buffer
		package main
		
		import (
			"bytes"
			"fmt"
			"os"
		)
		
		func main() {
			var b bytes.Buffer // A Buffer needs no initialization.
			b.Write([]byte("Hello "))
			fmt.Fprintf(&b, "world!")
			b.WriteTo(os.Stdout)
		}

	Buffer_Bytes
		package main
		
		import (
			"bytes"
			"os"
		)
		
		func main() {
			buf := bytes.Buffer{}
			buf.Write([]byte{'h', 'e', 'l', 'l', 'o', ' ', 'w', 'o', 'r', 'l', 'd'})
			os.Stdout.Write(buf.Bytes())
		}

	Buffer_Grow
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			var b bytes.Buffer
			b.Grow(64)
			bb := b.Bytes()
			b.Write([]byte("64 bytes or fewer"))
			fmt.Printf("%q", bb[:b.Len()])
		}

	Buffer_Len
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			var b bytes.Buffer
			b.Grow(64)
			b.Write([]byte("abcde"))
			fmt.Printf("%d", b.Len())
		}

	Buffer_reader
		package main
		
		import (
			"bytes"
			"encoding/base64"
			"io"
			"os"
		)
		
		func main() {
			// A Buffer can turn a string or a []byte into an io.Reader.
			buf := bytes.NewBufferString("R29waGVycyBydWxlIQ==")
			dec := base64.NewDecoder(base64.StdEncoding, buf)
			io.Copy(os.Stdout, dec)
		}

	Compare
		package main
		
		import (
			"bytes"
		)
		
		func main() {
			// Interpret Compare's result by comparing it to zero.
			var a, b []byte
			if bytes.Compare(a, b) < 0 {
				// a less b
			}
			if bytes.Compare(a, b) <= 0 {
				// a less or equal b
			}
			if bytes.Compare(a, b) > 0 {
				// a greater b
			}
			if bytes.Compare(a, b) >= 0 {
				// a greater or equal b
			}
		
			// Prefer Equal to Compare for equality comparisons.
			if bytes.Equal(a, b) {
				// a equal b
			}
			if !bytes.Equal(a, b) {
				// a not equal b
			}
		}

	Compare_search
		package main
		
		import (
			"bytes"
			"sort"
		)
		
		func main() {
			// Binary search to find a matching byte slice.
			var needle []byte
			var haystack [][]byte // Assume sorted
			i := sort.Search(len(haystack), func(i int) bool {
				// Return haystack[i] >= needle.
				return bytes.Compare(haystack[i], needle) >= 0
			})
			if i < len(haystack) && bytes.Equal(haystack[i], needle) {
				// Found it!
			}
		}

	Contains
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.Contains([]byte("seafood"), []byte("foo")))
			fmt.Println(bytes.Contains([]byte("seafood"), []byte("bar")))
			fmt.Println(bytes.Contains([]byte("seafood"), []byte("")))
			fmt.Println(bytes.Contains([]byte(""), []byte("")))
		}

	ContainsAny
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.ContainsAny([]byte("I like seafood."), "fÄo!"))
			fmt.Println(bytes.ContainsAny([]byte("I like seafood."), "去是伟大的."))
			fmt.Println(bytes.ContainsAny([]byte("I like seafood."), ""))
			fmt.Println(bytes.ContainsAny([]byte(""), ""))
		}

	ContainsRune
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.ContainsRune([]byte("I like seafood."), 'f'))
			fmt.Println(bytes.ContainsRune([]byte("I like seafood."), 'ö'))
			fmt.Println(bytes.ContainsRune([]byte("去是伟大的!"), '大'))
			fmt.Println(bytes.ContainsRune([]byte("去是伟大的!"), '!'))
			fmt.Println(bytes.ContainsRune([]byte(""), '@'))
		}

	Count
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.Count([]byte("cheese"), []byte("e")))
			fmt.Println(bytes.Count([]byte("five"), []byte(""))) // before & after each rune
		}

	Equal
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.Equal([]byte("Go"), []byte("Go")))
			fmt.Println(bytes.Equal([]byte("Go"), []byte("C++")))
		}

	EqualFold
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.EqualFold([]byte("Go"), []byte("go")))
		}

	Fields
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("Fields are: %q", bytes.Fields([]byte("  foo bar  baz   ")))
		}

	FieldsFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			f := func(c rune) bool {
				return !unicode.IsLetter(c) && !unicode.IsNumber(c)
			}
			fmt.Printf("Fields are: %q", bytes.FieldsFunc([]byte("  foo1;bar2,baz3..."), f))
		}

	HasPrefix
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.HasPrefix([]byte("Gopher"), []byte("Go")))
			fmt.Println(bytes.HasPrefix([]byte("Gopher"), []byte("C")))
			fmt.Println(bytes.HasPrefix([]byte("Gopher"), []byte("")))
		}

	HasSuffix
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.HasSuffix([]byte("Amigo"), []byte("go")))
			fmt.Println(bytes.HasSuffix([]byte("Amigo"), []byte("O")))
			fmt.Println(bytes.HasSuffix([]byte("Amigo"), []byte("Ami")))
			fmt.Println(bytes.HasSuffix([]byte("Amigo"), []byte("")))
		}

	Index
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.Index([]byte("chicken"), []byte("ken")))
			fmt.Println(bytes.Index([]byte("chicken"), []byte("dmr")))
		}

	IndexAny
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.IndexAny([]byte("chicken"), "aeiouy"))
			fmt.Println(bytes.IndexAny([]byte("crwth"), "aeiouy"))
		}

	IndexByte
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.IndexByte([]byte("chicken"), byte('k')))
			fmt.Println(bytes.IndexByte([]byte("chicken"), byte('g')))
		}

	IndexFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			f := func(c rune) bool {
				return unicode.Is(unicode.Han, c)
			}
			fmt.Println(bytes.IndexFunc([]byte("Hello, 世界"), f))
			fmt.Println(bytes.IndexFunc([]byte("Hello, world"), f))
		}

	IndexRune
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.IndexRune([]byte("chicken"), 'k'))
			fmt.Println(bytes.IndexRune([]byte("chicken"), 'd'))
		}

	Join
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			s := [][]byte{[]byte("foo"), []byte("bar"), []byte("baz")}
			fmt.Printf("%s", bytes.Join(s, []byte(", ")))
		}

	LastIndex
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.Index([]byte("go gopher"), []byte("go")))
			fmt.Println(bytes.LastIndex([]byte("go gopher"), []byte("go")))
			fmt.Println(bytes.LastIndex([]byte("go gopher"), []byte("rodent")))
		}

	LastIndexAny
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.LastIndexAny([]byte("go gopher"), "MüQp"))
			fmt.Println(bytes.LastIndexAny([]byte("go 地鼠"), "地大"))
			fmt.Println(bytes.LastIndexAny([]byte("go gopher"), "z,!."))
		}

	LastIndexByte
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.LastIndexByte([]byte("go gopher"), byte('g')))
			fmt.Println(bytes.LastIndexByte([]byte("go gopher"), byte('r')))
			fmt.Println(bytes.LastIndexByte([]byte("go gopher"), byte('z')))
		}

	LastIndexFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			fmt.Println(bytes.LastIndexFunc([]byte("go gopher!"), unicode.IsLetter))
			fmt.Println(bytes.LastIndexFunc([]byte("go gopher!"), unicode.IsPunct))
			fmt.Println(bytes.LastIndexFunc([]byte("go gopher!"), unicode.IsNumber))
		}

	Map
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			rot13 := func(r rune) rune {
				switch {
				case r >= 'A' && r <= 'Z':
					return 'A' + (r-'A'+13)%26
				case r >= 'a' && r <= 'z':
					return 'a' + (r-'a'+13)%26
				}
				return r
			}
			fmt.Printf("%s", bytes.Map(rot13, []byte("'Twas brillig and the slithy gopher...")))
		}

	Reader_Len
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Println(bytes.NewReader([]byte("Hi!")).Len())
			fmt.Println(bytes.NewReader([]byte("こんにちは!")).Len())
		}

	Repeat
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("ba%s", bytes.Repeat([]byte("na"), 2))
		}

	Replace
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s\n", bytes.Replace([]byte("oink oink oink"), []byte("k"), []byte("ky"), 2))
			fmt.Printf("%s\n", bytes.Replace([]byte("oink oink oink"), []byte("oink"), []byte("moo"), -1))
		}

	ReplaceAll
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s\n", bytes.ReplaceAll([]byte("oink oink oink"), []byte("oink"), []byte("moo")))
		}

	Runes
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			rs := bytes.Runes([]byte("go gopher"))
			for _, r := range rs {
				fmt.Printf("%#U\n", r)
			}
		}

	Split
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%q\n", bytes.Split([]byte("a,b,c"), []byte(",")))
			fmt.Printf("%q\n", bytes.Split([]byte("a man a plan a canal panama"), []byte("a ")))
			fmt.Printf("%q\n", bytes.Split([]byte(" xyz "), []byte("")))
			fmt.Printf("%q\n", bytes.Split([]byte(""), []byte("Bernardo O'Higgins")))
		}

	SplitAfter
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%q\n", bytes.SplitAfter([]byte("a,b,c"), []byte(",")))
		}

	SplitAfterN
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%q\n", bytes.SplitAfterN([]byte("a,b,c"), []byte(","), 2))
		}

	SplitN
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%q\n", bytes.SplitN([]byte("a,b,c"), []byte(","), 2))
			z := bytes.SplitN([]byte("a,b,c"), []byte(","), 0)
			fmt.Printf("%q (nil = %v)\n", z, z == nil)
		}

	Title
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s", bytes.Title([]byte("her royal highness")))
		}

	ToLower
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s", bytes.ToLower([]byte("Gopher")))
		}

	ToLowerSpecial
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			str := []byte("AHOJ VÝVOJÁRİ GOLANG")
			totitle := bytes.ToLowerSpecial(unicode.AzeriCase, str)
			fmt.Println("Original : " + string(str))
			fmt.Println("ToLower : " + string(totitle))
		}

	ToTitle
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s\n", bytes.ToTitle([]byte("loud noises")))
			fmt.Printf("%s\n", bytes.ToTitle([]byte("хлеб")))
		}

	ToTitleSpecial
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			str := []byte("ahoj vývojári golang")
			totitle := bytes.ToTitleSpecial(unicode.AzeriCase, str)
			fmt.Println("Original : " + string(str))
			fmt.Println("ToTitle : " + string(totitle))
		}

	ToUpper
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s", bytes.ToUpper([]byte("Gopher")))
		}

	ToUpperSpecial
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			str := []byte("ahoj vývojári golang")
			totitle := bytes.ToUpperSpecial(unicode.AzeriCase, str)
			fmt.Println("Original : " + string(str))
			fmt.Println("ToUpper : " + string(totitle))
		}

	Trim
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("[%q]", bytes.Trim([]byte(" !!! Achtung! Achtung! !!! "), "! "))
		}

	TrimFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			fmt.Println(string(bytes.TrimFunc([]byte("go-gopher!"), unicode.IsLetter)))
			fmt.Println(string(bytes.TrimFunc([]byte("\"go-gopher!\""), unicode.IsLetter)))
			fmt.Println(string(bytes.TrimFunc([]byte("go-gopher!"), unicode.IsPunct)))
			fmt.Println(string(bytes.TrimFunc([]byte("1234go-gopher!567"), unicode.IsNumber)))
		}

	TrimLeft
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Print(string(bytes.TrimLeft([]byte("453gopher8257"), "0123456789")))
		}

	TrimLeftFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			fmt.Println(string(bytes.TrimLeftFunc([]byte("go-gopher"), unicode.IsLetter)))
			fmt.Println(string(bytes.TrimLeftFunc([]byte("go-gopher!"), unicode.IsPunct)))
			fmt.Println(string(bytes.TrimLeftFunc([]byte("1234go-gopher!567"), unicode.IsNumber)))
		}

	TrimPrefix
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			var b = []byte("Goodbye,, world!")
			b = bytes.TrimPrefix(b, []byte("Goodbye,"))
			b = bytes.TrimPrefix(b, []byte("See ya,"))
			fmt.Printf("Hello%s", b)
		}

	TrimRight
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Print(string(bytes.TrimRight([]byte("453gopher8257"), "0123456789")))
		}

	TrimRightFunc
		package main
		
		import (
			"bytes"
			"fmt"
			"unicode"
		)
		
		func main() {
			fmt.Println(string(bytes.TrimRightFunc([]byte("go-gopher"), unicode.IsLetter)))
			fmt.Println(string(bytes.TrimRightFunc([]byte("go-gopher!"), unicode.IsPunct)))
			fmt.Println(string(bytes.TrimRightFunc([]byte("1234go-gopher!567"), unicode.IsNumber)))
		}

	TrimSpace
		package main
		
		import (
			"bytes"
			"fmt"
		)
		
		func main() {
			fmt.Printf("%s", bytes.TrimSpace([]byte(" \t\n a lone gopher \n\t\r\n")))
		}

	TrimSuffix
		package main
		
		import (
			"bytes"
			"os"
		)
		
		func main() {
			var b = []byte("Hello, goodbye, etc!")
			b = bytes.TrimSuffix(b, []byte("goodbye, etc!"))
			b = bytes.TrimSuffix(b, []byte("gopher"))
			b = append(b, bytes.TrimSuffix([]byte("world!"), []byte("x!"))...)
			os.Stdout.Write(b)
		}


Package-Level Type Names (total 4, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Buffer (struct)
		A Buffer is a variable-sized buffer of bytes with Read and Write methods.
		The zero value for Buffer is an empty buffer ready to use.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			buf []byte
				// contents are the bytes buf[off : len(buf)]

			lastRead readOp
				// last read operation, so that Unread* can work correctly.

			off int
				// read at &buf[off], write at &buf[len(buf)]

		Methods (total 25, in which 21 are exported)
			(*T) Bytes() []byte
				Bytes returns a slice of length b.Len() holding the unread portion of the buffer.
				The slice is valid for use only until the next buffer modification (that is,
				only until the next call to a method like Read, Write, Reset, or Truncate).
				The slice aliases the buffer content at least until the next buffer modification,
				so immediate changes to the slice will affect the result of future reads.

			(*T) Cap() int
				Cap returns the capacity of the buffer's underlying byte slice, that is, the
				total space allocated for the buffer's data.

			(*T) Grow(n int)
				Grow grows the buffer's capacity, if necessary, to guarantee space for
				another n bytes. After Grow(n), at least n bytes can be written to the
				buffer without another allocation.
				If n is negative, Grow will panic.
				If the buffer can't grow it will panic with ErrTooLarge.

			(*T) Len() int
				Len returns the number of bytes of the unread portion of the buffer;
				b.Len() == len(b.Bytes()).

			(*T) Next(n int) []byte
				Next returns a slice containing the next n bytes from the buffer,
				advancing the buffer as if the bytes had been returned by Read.
				If there are fewer than n bytes in the buffer, Next returns the entire buffer.
				The slice is only valid until the next call to a read or write method.

			(*T) Read(p []byte) (n int, err error)
				Read reads the next len(p) bytes from the buffer or until the buffer
				is drained. The return value n is the number of bytes read. If the
				buffer has no data to return, err is io.EOF (unless len(p) is zero);
				otherwise it is nil.

			(*T) ReadByte() (byte, error)
				ReadByte reads and returns the next byte from the buffer.
				If no byte is available, it returns error io.EOF.

			(*T) ReadBytes(delim byte) (line []byte, err error)
				ReadBytes reads until the first occurrence of delim in the input,
				returning a slice containing the data up to and including the delimiter.
				If ReadBytes encounters an error before finding a delimiter,
				it returns the data read before the error and the error itself (often io.EOF).
				ReadBytes returns err != nil if and only if the returned data does not end in
				delim.

			(*T) ReadFrom(r io.Reader) (n int64, err error)
				ReadFrom reads data from r until EOF and appends it to the buffer, growing
				the buffer as needed. The return value n is the number of bytes read. Any
				error except io.EOF encountered during the read is also returned. If the
				buffer becomes too large, ReadFrom will panic with ErrTooLarge.

			(*T) ReadRune() (r rune, size int, err error)
				ReadRune reads and returns the next UTF-8-encoded
				Unicode code point from the buffer.
				If no bytes are available, the error returned is io.EOF.
				If the bytes are an erroneous UTF-8 encoding, it
				consumes one byte and returns U+FFFD, 1.

			(*T) ReadString(delim byte) (line string, err error)
				ReadString reads until the first occurrence of delim in the input,
				returning a string containing the data up to and including the delimiter.
				If ReadString encounters an error before finding a delimiter,
				it returns the data read before the error and the error itself (often io.EOF).
				ReadString returns err != nil if and only if the returned data does not end
				in delim.

			(*T) Reset()
				Reset resets the buffer to be empty,
				but it retains the underlying storage for use by future writes.
				Reset is the same as Truncate(0).

			(*T) String() string
				String returns the contents of the unread portion of the buffer
				as a string. If the Buffer is a nil pointer, it returns "<nil>".

				To build strings more efficiently, see the strings.Builder type.

			(*T) Truncate(n int)
				Truncate discards all but the first n unread bytes from the buffer
				but continues to use the same allocated storage.
				It panics if n is negative or greater than the length of the buffer.

			(*T) UnreadByte() error
				UnreadByte unreads the last byte returned by the most recent successful
				read operation that read at least one byte. If a write has happened since
				the last read, if the last read returned an error, or if the read read zero
				bytes, UnreadByte returns an error.

			(*T) UnreadRune() error
				UnreadRune unreads the last rune returned by ReadRune.
				If the most recent read or write operation on the buffer was
				not a successful ReadRune, UnreadRune returns an error.  (In this regard
				it is stricter than UnreadByte, which will unread the last byte
				from any read operation.)

			(*T) Write(p []byte) (n int, err error)
				Write appends the contents of p to the buffer, growing the buffer as
				needed. The return value n is the length of p; err is always nil. If the
				buffer becomes too large, Write will panic with ErrTooLarge.

			(*T) WriteByte(c byte) error
				WriteByte appends the byte c to the buffer, growing the buffer as needed.
				The returned error is always nil, but is included to match bufio.Writer's
				WriteByte. If the buffer becomes too large, WriteByte will panic with
				ErrTooLarge.

			(*T) WriteRune(r rune) (n int, err error)
				WriteRune appends the UTF-8 encoding of Unicode code point r to the
				buffer, returning its length and an error, which is always nil but is
				included to match bufio.Writer's WriteRune. The buffer is grown as needed;
				if it becomes too large, WriteRune will panic with ErrTooLarge.

			(*T) WriteString(s string) (n int, err error)
				WriteString appends the contents of s to the buffer, growing the buffer as
				needed. The return value n is the length of s; err is always nil. If the
				buffer becomes too large, WriteString will panic with ErrTooLarge.

			(*T) WriteTo(w io.Writer) (n int64, err error)
				WriteTo writes data to w until the buffer is drained or an error occurs.
				The return value n is the number of bytes written; it always fits into an
				int, but it is int64 to match the io.WriterTo interface. Any error
				encountered during the write is also returned.

			/* 4 unexporteds ... *//* 4 unexporteds: */
			(*T) empty() bool
				empty reports whether the unread portion of the buffer is empty.

			(*T) grow(n int) int
				grow grows the buffer to guarantee space for n more bytes.
				It returns the index where bytes should be written.
				If the buffer can't grow it will panic with ErrTooLarge.

			(*T) readSlice(delim byte) (line []byte, err error)
				readSlice is like ReadBytes but returns a reference to internal buffer data.

			(*T) tryGrowByReslice(n int) (int, bool)
				tryGrowByReslice is a inlineable version of grow for the fast-case where the
				internal buffer only needs to be resliced.
				It returns the index where bytes should be written and whether it succeeded.

		Implements (at least 14, in which 12 are exported)
			*T : fmt.Stringer
			*T : io.ByteReader
			*T : io.ByteScanner
			*T : io.ByteWriter
			*T : io.Reader
			*T : io.ReaderFrom
			*T : io.ReadWriter
			*T : io.RuneReader
			*T : io.RuneScanner
			*T : io.StringWriter
			*T : io.Writer
			*T : io.WriterTo
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*T : context.stringer
			*T : runtime.stringer
		As Outputs Of (at least 2, both are exported)
			func NewBuffer(buf []byte) *Buffer
			func NewBufferString(s string) *Buffer
		As Inputs Of (at least 5, in which 3 are exported)
			func encoding/json.Compact(dst *Buffer, src []byte) error
			func encoding/json.HTMLEscape(dst *Buffer, src []byte)
			func encoding/json.Indent(dst *Buffer, src []byte, prefix, indent string) error
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func encoding/json.compact(dst *Buffer, src []byte, escape bool) error
			func encoding/json.newline(dst *Buffer, prefix, indent string, depth int)

	 type Reader (struct)
		A Reader implements the io.Reader, io.ReaderAt, io.WriterTo, io.Seeker,
		io.ByteScanner, and io.RuneScanner interfaces by reading from
		a byte slice.
		Unlike a Buffer, a Reader is read-only and supports seeking.
		The zero value for Reader operates like a Reader of an empty slice.

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			i int64
				// current reading index

			prevRune int
				// index of previous rune; or < 0

			s []byte
		Methods (total 11, all are exported)
			(*T) Len() int
				Len returns the number of bytes of the unread portion of the
				slice.

			(*T) Read(b []byte) (n int, err error)
				Read implements the io.Reader interface.

			(*T) ReadAt(b []byte, off int64) (n int, err error)
				ReadAt implements the io.ReaderAt interface.

			(*T) ReadByte() (byte, error)
				ReadByte implements the io.ByteReader interface.

			(*T) ReadRune() (ch rune, size int, err error)
				ReadRune implements the io.RuneReader interface.

			(*T) Reset(b []byte)
				Reset resets the Reader to be reading from b.

			(*T) Seek(offset int64, whence int) (int64, error)
				Seek implements the io.Seeker interface.

			(*T) Size() int64
				Size returns the original length of the underlying byte slice.
				Size is the number of bytes available for reading via ReadAt.
				The returned value is always the same and is not affected by calls
				to any other method.

			(*T) UnreadByte() error
				UnreadByte complements ReadByte in implementing the io.ByteScanner interface.

			(*T) UnreadRune() error
				UnreadRune complements ReadRune in implementing the io.RuneScanner interface.

			(*T) WriteTo(w io.Writer) (n int64, err error)
				WriteTo implements the io.WriterTo interface.

		Implements (at least 9, all are exported)
			*T : io.ByteReader
			*T : io.ByteScanner
			*T : io.Reader
			*T : io.ReaderAt
			*T : io.ReadSeeker
			*T : io.RuneReader
			*T : io.RuneScanner
			*T : io.Seeker
			*T : io.WriterTo
		As Outputs Of (at least one exported)
			func NewReader(b []byte) *Reader

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type asciiSet ([...]T)
		asciiSet is a 32-byte value, where each bit represents the presence of a
		given ASCII character in the set. The 128-bits of the lower 16 bytes,
		starting with the least-significant bit of the lowest word to the
		most-significant bit of the highest word, map to the full range of all
		128 ASCII characters. The 128-bits of the upper 16 bytes will be zeroed,
		ensuring that any non-ASCII character will be reported as not in the set.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*T) contains(c byte) bool
				contains reports whether c is inside the set.

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func makeASCIISet(chars string) (as asciiSet, ok bool)

	 type readOp int8 (basic type)
		The readOp constants describe the last action performed on
		the buffer, so that UnreadRune and UnreadByte can check for
		invalid usage. opReadRuneX constants are chosen such that
		converted to int they correspond to the rune size that was read.

		As Types Of (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			const opInvalid
			const opRead
			const opReadRune1
			const opReadRune2
			const opReadRune3
			const opReadRune4


Package-Level Functions (total 59, in which 50 are exported)

	 func Compare(a, b []byte) int
		Compare returns an integer comparing two byte slices lexicographically.
		The result will be 0 if a==b, -1 if a < b, and +1 if a > b.
		A nil argument is equivalent to an empty slice.

	 func Contains(b, subslice []byte) bool
		Contains reports whether subslice is within b.

	 func ContainsAny(b []byte, chars string) bool
		ContainsAny reports whether any of the UTF-8-encoded code points in chars are within b.

	 func ContainsRune(b []byte, r rune) bool
		ContainsRune reports whether the rune is contained in the UTF-8-encoded byte slice b.

	 func Count(s, sep []byte) int
		Count counts the number of non-overlapping instances of sep in s.
		If sep is an empty slice, Count returns 1 + the number of UTF-8-encoded code points in s.

	 func Equal(a, b []byte) bool
		Equal reports whether a and b
		are the same length and contain the same bytes.
		A nil argument is equivalent to an empty slice.

	 func EqualFold(s, t []byte) bool
		EqualFold reports whether s and t, interpreted as UTF-8 strings,
		are equal under Unicode case-folding, which is a more general
		form of case-insensitivity.

	 func Fields(s []byte) [][]byte
		Fields interprets s as a sequence of UTF-8-encoded code points.
		It splits the slice s around each instance of one or more consecutive white space
		characters, as defined by unicode.IsSpace, returning a slice of subslices of s or an
		empty slice if s contains only white space.

	 func FieldsFunc(s []byte, f func(rune) bool) [][]byte
		FieldsFunc interprets s as a sequence of UTF-8-encoded code points.
		It splits the slice s at each run of code points c satisfying f(c) and
		returns a slice of subslices of s. If all code points in s satisfy f(c), or
		len(s) == 0, an empty slice is returned.

		FieldsFunc makes no guarantees about the order in which it calls f(c)
		and assumes that f always returns the same value for a given c.

	 func HasPrefix(s, prefix []byte) bool
		HasPrefix tests whether the byte slice s begins with prefix.

	 func HasSuffix(s, suffix []byte) bool
		HasSuffix tests whether the byte slice s ends with suffix.

	 func Index(s, sep []byte) int
		Index returns the index of the first instance of sep in s, or -1 if sep is not present in s.

	 func IndexAny(s []byte, chars string) int
		IndexAny interprets s as a sequence of UTF-8-encoded Unicode code points.
		It returns the byte index of the first occurrence in s of any of the Unicode
		code points in chars. It returns -1 if chars is empty or if there is no code
		point in common.

	 func IndexByte(b []byte, c byte) int
		IndexByte returns the index of the first instance of c in b, or -1 if c is not present in b.

	 func IndexFunc(s []byte, f func(r rune) bool) int
		IndexFunc interprets s as a sequence of UTF-8-encoded code points.
		It returns the byte index in s of the first Unicode
		code point satisfying f(c), or -1 if none do.

	 func IndexRune(s []byte, r rune) int
		IndexRune interprets s as a sequence of UTF-8-encoded code points.
		It returns the byte index of the first occurrence in s of the given rune.
		It returns -1 if rune is not present in s.
		If r is utf8.RuneError, it returns the first instance of any
		invalid UTF-8 byte sequence.

	 func Join(s [][]byte, sep []byte) []byte
		Join concatenates the elements of s to create a new byte slice. The separator
		sep is placed between elements in the resulting slice.

	 func LastIndex(s, sep []byte) int
		LastIndex returns the index of the last instance of sep in s, or -1 if sep is not present in s.

	 func LastIndexAny(s []byte, chars string) int
		LastIndexAny interprets s as a sequence of UTF-8-encoded Unicode code
		points. It returns the byte index of the last occurrence in s of any of
		the Unicode code points in chars. It returns -1 if chars is empty or if
		there is no code point in common.

	 func LastIndexByte(s []byte, c byte) int
		LastIndexByte returns the index of the last instance of c in s, or -1 if c is not present in s.

	 func LastIndexFunc(s []byte, f func(r rune) bool) int
		LastIndexFunc interprets s as a sequence of UTF-8-encoded code points.
		It returns the byte index in s of the last Unicode
		code point satisfying f(c), or -1 if none do.

	 func Map(mapping func(r rune) rune, s []byte) []byte
		Map returns a copy of the byte slice s with all its characters modified
		according to the mapping function. If mapping returns a negative value, the character is
		dropped from the byte slice with no replacement. The characters in s and the
		output are interpreted as UTF-8-encoded code points.

	 func NewBuffer(buf []byte) *Buffer
		NewBuffer creates and initializes a new Buffer using buf as its
		initial contents. The new Buffer takes ownership of buf, and the
		caller should not use buf after this call. NewBuffer is intended to
		prepare a Buffer to read existing data. It can also be used to set
		the initial size of the internal buffer for writing. To do that,
		buf should have the desired capacity but a length of zero.

		In most cases, new(Buffer) (or just declaring a Buffer variable) is
		sufficient to initialize a Buffer.

	 func NewBufferString(s string) *Buffer
		NewBufferString creates and initializes a new Buffer using string s as its
		initial contents. It is intended to prepare a buffer to read an existing
		string.

		In most cases, new(Buffer) (or just declaring a Buffer variable) is
		sufficient to initialize a Buffer.

	 func NewReader(b []byte) *Reader
		NewReader returns a new Reader reading from b.

	 func Repeat(b []byte, count int) []byte
		Repeat returns a new byte slice consisting of count copies of b.

		It panics if count is negative or if
		the result of (len(b) * count) overflows.

	 func Replace(s, old, new []byte, n int) []byte
		Replace returns a copy of the slice s with the first n
		non-overlapping instances of old replaced by new.
		If old is empty, it matches at the beginning of the slice
		and after each UTF-8 sequence, yielding up to k+1 replacements
		for a k-rune slice.
		If n < 0, there is no limit on the number of replacements.

	 func ReplaceAll(s, old, new []byte) []byte
		ReplaceAll returns a copy of the slice s with all
		non-overlapping instances of old replaced by new.
		If old is empty, it matches at the beginning of the slice
		and after each UTF-8 sequence, yielding up to k+1 replacements
		for a k-rune slice.

	 func Runes(s []byte) []rune
		Runes interprets s as a sequence of UTF-8-encoded code points.
		It returns a slice of runes (Unicode code points) equivalent to s.

	 func Split(s, sep []byte) [][]byte
		Split slices s into all subslices separated by sep and returns a slice of
		the subslices between those separators.
		If sep is empty, Split splits after each UTF-8 sequence.
		It is equivalent to SplitN with a count of -1.

	 func SplitAfter(s, sep []byte) [][]byte
		SplitAfter slices s into all subslices after each instance of sep and
		returns a slice of those subslices.
		If sep is empty, SplitAfter splits after each UTF-8 sequence.
		It is equivalent to SplitAfterN with a count of -1.

	 func SplitAfterN(s, sep []byte, n int) [][]byte
		SplitAfterN slices s into subslices after each instance of sep and
		returns a slice of those subslices.
		If sep is empty, SplitAfterN splits after each UTF-8 sequence.
		The count determines the number of subslices to return:
		  n > 0: at most n subslices; the last subslice will be the unsplit remainder.
		  n == 0: the result is nil (zero subslices)
		  n < 0: all subslices

	 func SplitN(s, sep []byte, n int) [][]byte
		SplitN slices s into subslices separated by sep and returns a slice of
		the subslices between those separators.
		If sep is empty, SplitN splits after each UTF-8 sequence.
		The count determines the number of subslices to return:
		  n > 0: at most n subslices; the last subslice will be the unsplit remainder.
		  n == 0: the result is nil (zero subslices)
		  n < 0: all subslices

	 func Title(s []byte) []byte
		Title treats s as UTF-8-encoded bytes and returns a copy with all Unicode letters that begin
		words mapped to their title case.

		BUG(rsc): The rule Title uses for word boundaries does not handle Unicode punctuation properly.

	 func ToLower(s []byte) []byte
		ToLower returns a copy of the byte slice s with all Unicode letters mapped to
		their lower case.

	 func ToLowerSpecial(c unicode.SpecialCase, s []byte) []byte
		ToLowerSpecial treats s as UTF-8-encoded bytes and returns a copy with all the Unicode letters mapped to their
		lower case, giving priority to the special casing rules.

	 func ToTitle(s []byte) []byte
		ToTitle treats s as UTF-8-encoded bytes and returns a copy with all the Unicode letters mapped to their title case.

	 func ToTitleSpecial(c unicode.SpecialCase, s []byte) []byte
		ToTitleSpecial treats s as UTF-8-encoded bytes and returns a copy with all the Unicode letters mapped to their
		title case, giving priority to the special casing rules.

	 func ToUpper(s []byte) []byte
		ToUpper returns a copy of the byte slice s with all Unicode letters mapped to
		their upper case.

	 func ToUpperSpecial(c unicode.SpecialCase, s []byte) []byte
		ToUpperSpecial treats s as UTF-8-encoded bytes and returns a copy with all the Unicode letters mapped to their
		upper case, giving priority to the special casing rules.

	 func ToValidUTF8(s, replacement []byte) []byte
		ToValidUTF8 treats s as UTF-8-encoded bytes and returns a copy with each run of bytes
		representing invalid UTF-8 replaced with the bytes in replacement, which may be empty.

	 func Trim(s []byte, cutset string) []byte
		Trim returns a subslice of s by slicing off all leading and
		trailing UTF-8-encoded code points contained in cutset.

	 func TrimFunc(s []byte, f func(r rune) bool) []byte
		TrimFunc returns a subslice of s by slicing off all leading and trailing
		UTF-8-encoded code points c that satisfy f(c).

	 func TrimLeft(s []byte, cutset string) []byte
		TrimLeft returns a subslice of s by slicing off all leading
		UTF-8-encoded code points contained in cutset.

	 func TrimLeftFunc(s []byte, f func(r rune) bool) []byte
		TrimLeftFunc treats s as UTF-8-encoded bytes and returns a subslice of s by slicing off
		all leading UTF-8-encoded code points c that satisfy f(c).

	 func TrimPrefix(s, prefix []byte) []byte
		TrimPrefix returns s without the provided leading prefix string.
		If s doesn't start with prefix, s is returned unchanged.

	 func TrimRight(s []byte, cutset string) []byte
		TrimRight returns a subslice of s by slicing off all trailing
		UTF-8-encoded code points that are contained in cutset.

	 func TrimRightFunc(s []byte, f func(r rune) bool) []byte
		TrimRightFunc returns a subslice of s by slicing off all trailing
		UTF-8-encoded code points c that satisfy f(c).

	 func TrimSpace(s []byte) []byte
		TrimSpace returns a subslice of s by slicing off all leading and
		trailing white space, as defined by Unicode.

	 func TrimSuffix(s, suffix []byte) []byte
		TrimSuffix returns s without the provided trailing suffix string.
		If s doesn't end with suffix, s is returned unchanged.

	/* 9 unexporteds ... *//* 9 unexporteds: */
	 func explode(s []byte, n int) [][]byte
		explode splits s into a slice of UTF-8 sequences, one per Unicode code point (still slices of bytes),
		up to a maximum of n byte slices. Invalid UTF-8 sequences are chopped into individual bytes.

	 func genSplit(s, sep []byte, sepSave, n int) [][]byte
		Generic split: splits after each instance of sep,
		including sepSave bytes of sep in the subslices.

	 func indexBytePortable(s []byte, c byte) int
	 func indexFunc(s []byte, f func(r rune) bool, truth bool) int
		indexFunc is the same as IndexFunc except that if
		truth==false, the sense of the predicate function is
		inverted.

	 func isSeparator(r rune) bool
		isSeparator reports whether the rune could mark a word boundary.
		TODO: update when package unicode captures more of the properties.

	 func lastIndexFunc(s []byte, f func(r rune) bool, truth bool) int
		lastIndexFunc is the same as LastIndexFunc except that if
		truth==false, the sense of the predicate function is
		inverted.

	 func makeASCIISet(chars string) (as asciiSet, ok bool)
		makeASCIISet creates a set of ASCII characters and reports whether all
		characters in chars are ASCII.

	 func makeCutsetFunc(cutset string) func(r rune) bool
	 func makeSlice(n int) []byte
		makeSlice allocates a slice of size n. If the allocation fails, it panics
		with ErrTooLarge.


Package-Level Variables (total 4, in which 1 are exported)

	  var ErrTooLarge error
		ErrTooLarge is passed to panic if memory cannot be allocated to store data in a buffer.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var asciiSpace [256]uint8
	  var errNegativeRead error
	  var errUnreadByte error
Package-Level Constants (total 9, in which 1 are exported)

	const MinRead = 512
		MinRead is the minimum slice size passed to a Read call by
		Buffer.ReadFrom. As long as the Buffer has at least MinRead bytes beyond
		what is required to hold the contents of r, ReadFrom will not grow the
		underlying buffer.

	/* 8 unexporteds ... *//* 8 unexporteds: */
	const maxInt int = 9223372036854775807
	const opInvalid readOp = 0 // Non-read operation.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const opRead readOp = -1 // Any other read operation.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const opReadRune1 readOp = 1 // Read rune of size 1.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const opReadRune2 readOp = 2 // Read rune of size 2.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const opReadRune3 readOp = 3 // Read rune of size 3.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const opReadRune4 readOp = 4 // Read rune of size 4.
		Don't use iota for these, as the values need to correspond with the
		names and comments, which is easier to see when being explicit.

	const smallBufferSize = 64
		smallBufferSize is an initial allocation minimal capacity.

The pages are generated with Golds v0.4.2. (GOOS=darwin 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.