Go1.11标准库bytes包及Demo

bytes包实现了操作[]byte的常用函数。本包的函数和strings包的函数相当类似。

Struct

Buffer

Buffer是一个实现了读写方法的可变大小的字节缓冲。本类型的零值是一个空的可用于读写的缓冲。

type Buffer struct {
	buf       []byte   // 包含的 bytes buf[off : len(buf)]
	off       int      // 读取 &buf[off], 写入&buf[len(buf)]
	bootstrap [64]byte // 存储第一个切片的内存；帮助小缓冲区避免分配内存
	lastRead  readOp   // 上次读取操作，以便Unread* 可以正常工作。
	// FIXME: 建议将缓冲区与缓存线对齐，以避免错误共享。
}

Function

• Bytes

func (b *Buffer) Bytes() []byte

返回未读取部分字节数据的切片，len(b.Bytes())==b. Len ()。如果中间没有调用其他方法，修改返回的切片的内容会直接改变 Buffer 的内容。

• Grow

func (b *Buffer) Grow(n int)

必要时会增加缓冲的容量，以保证n字节的剩余空间。调用Grow(n)后至少可以向缓冲中写入n字节数据而无需申请内存。如果n小于零或者不能增加容量都会panic。

• Len

func (b *Buffer) Len() int

返回缓冲中未读取部分的字节长度；b.Len()==len(b. Bytes ())。

• Next

func (b *Buffer) Next(n int) []byte

返回未读取部分前n字节数据的切片，并且移动读取位置，就像调用了 Read 方法一样。如果缓冲内数据不足，会返回整个数据的切片。切片只在下一次调用b的读/写方法前才合法。

• Read

func (b *Buffer) Read(p []byte) (n int, err error)

Read方法从缓冲中读取数据直到缓冲中没有数据或者读取了len§字节数据，将读取的数据写入p。返回值n是读取的字节数，除非缓冲中完全没有数据可以读取并写入p，此时返回值err为 io .EOF；否则err总是nil。

• ReadByte

func (b *Buffer) ReadByte() (c byte, err error)

ReadByte读取并返回缓冲中的下一个字节。如果没有数据可用，返回值err为 io .EOF。

• ReadBytes

func (b *Buffer) ReadBytes(delim byte) (line []byte, err error)

ReadBytes读取直到第一次遇到delim字节，返回一个包含已读取的数据和delim字节的切片。如果ReadBytes方法在读取到delim之前遇到了错误，它会返回在错误之前读取的数据以及该错误（一般是 io .EOF）。当且仅当ReadBytes方法返回的切片不以delim结尾时，会返回一个非nil的错误。

• ReadFrom

func (b *Buffer) ReadFrom(r io.Reader) (n int64, err error)

ReadFrom从r中读取数据直到结束并将读取的数据写入缓冲中，如必要会增加缓冲容量。返回值n为从r读取并写入b的字节数；会返回读取时遇到的除了 io .EOF之外的错误。如果缓冲太大，ReadFrom会采用错误值ErrTooLarge引发panic。

• ReadRune

func (b *Buffer) ReadRune() (r rune, size int, err error)

ReadRune读取并返回缓冲中的下一个utf-8码值。如果没有数据可用，返回值err为 io .EOF。如果缓冲中的数据是错误的utf-8编码，本方法会吃掉一字节并返回(U+FFFD,1,nil)。

• ReadString

func (b *Buffer) ReadString(delim byte) (line string, err error)

ReadString读取直到第一次遇到delim字节，返回一个包含已读取的数据和delim字节的字符串。如果ReadString方法在读取到delim之前遇到了错误，它会返回在错误之前读取的数据以及该错误（一般是 io .EOF）。当且仅当ReadString方法返回的切片不以delim结尾时，会返回一个非nil的错误。

• Reset

func (b *Buffer) Reset()

Reset重设缓冲，因此会丢弃全部内容，等价于b. Truncate (0)。

• String

func (b *Buffer) String() string

将未读取部分的字节数据作为字符串返回，如果b是nil指针，会返回""。

• Truncate

func (b *Buffer) Truncate(n int)

丢弃缓冲中除前n字节数据外的其它数据，如果n小于零或者大于缓冲容量将panic。

• UnreadByte

func (b *Buffer) UnreadByte() error

UnreadByte吐出最近一次读取操作读取的最后一个字节。如果最后一次读取操作之后进行了写入，本方法会返回错误。

• UnreadRune

func (b *Buffer) UnreadRune() error

UnreadRune吐出最近一次调用 ReadRune 方法读取的 unicode 码值。如果最近一次读写操作不是 ReadRune ，本方法会返回错误。（这里就能看出来UnreadRune比 UnreadByte 严格多了）

• Write

func (b *Buffer) Write(p []byte) (n int, err error)

Write将p的内容写入缓冲中，如必要会增加缓冲容量。返回值n为len§，err总是nil。如果缓冲变得太大，Write会采用错误值ErrTooLarge引发panic

• WriteByte

func (b *Buffer) WriteByte(c byte) error

WriteByte将字节c写入缓冲中，如必要会增加缓冲容量。返回值总是nil，但仍保留以匹配 bufio.Writer 的WriteByte方法。如果缓冲太大，WriteByte会采用错误值ErrTooLarge引发panic。

• WriteRune

func (b *Buffer) WriteRune(r rune) (n int, err error)

WriteByte 将 unicode 码值r的utf-8编码写入缓冲中，如必要会增加缓冲容量。返回值总是nil，但仍保留以匹配 bufio.Writer 的WriteRune方法。如果缓冲太大，WriteRune会采用错误值ErrTooLarge引发panic。

• WriteString

func (b *Buffer) WriteString(s string) (n int, err error)

WriteString将s的内容写入缓冲中，如必要会增加缓冲容量。返回值n为len§，err总是nil。如果缓冲变得太大， Write 会采用错误值ErrTooLarge引发panic。

• WriteTo

func (b *Buffer) WriteTo(w io.Writer) (n int64, err error)

WriteTo从缓冲中读取数据直到缓冲内没有数据或遇到错误，并将这些数据写入w。返回值n为从b读取并写入w的字节数；返回值总是可以无溢出的写入int类型，但为了匹配 io.WriterTo 接口设为int64类型。从b读取是遇到的非 io .EOF错误及写入w时遇到的错误都会终止本方法并返回该错误。

Reader

Reader类型通过从一个[]byte读取数据，实现了 io.Reader 、 io.Seeker 、 io.ReaderAt 、 io.WriterTo 、 io.ByteScanner 、 io.RuneScanner 接口。

type Reader struct {
	s        []byte
	i        int64 // 当前读取索引
	prevRune int   // 上一个运行的索引; 或者 < 0
}

Function

• Len

func (r *Reader) Len() int

Len返回r包含的切片中还没有被读取的部分

• Read

func (r *Reader) Read(b []byte) (n int, err error)

Read实现IO.Reader接口。

• ReadAt

func (r *Reader) ReadAt(b []byte, off int64) (n int, err error)

ReadAt实现IO.ReaderAt接口。

• ReadByte

func (r *Reader) ReadByte() (b byte, err error)

ReadByte实现io.ByteReader接口。

• ReadRune

func (r *Reader) ReadRune() (ch rune, size int, err error)

ReadRune实现io.RuneReader接口。

• Seek

func (r *Reader) Seek(offset int64, whence int) (int64, error)

Seek实现了 io.Seeker 接口。

• UnreadByte

func (r *Reader) UnreadByte() error

UnreadByte在实现IO.Bytescanner接口时补充readByte。

• UnreadRune

func (r *Reader) ReadRune() (ch rune, size int, err error)

ReadRune实现了io.RuneReader接口。

• WriteTo

func (r *Reader) WriteTo(w io.Writer) (n int64, err error)

WriteTo 实现 io.WriterTo 接口。

Function

• Compare

func Compare(a, b []byte) int

Compare函数返回一个整数表示两个[]byte切片按字典序比较的结果（类同C的strcmp）。如果a==b返回0；如果a < b返回-1；否则返回+1。nil参数视为空切片。

• Contains

func Contains(b, subslice []byte) bool

判断切片b是否包含子切片subslice。

• Count

func Count(s, sep []byte) int

Count计算s中有多少个不重叠的sep子切片

• Equal

func Equal(a, b []byte) bool

判断两个切片的内容是否完全相同。

• EqualFold

func EqualFold(s, t []byte) bool

判断两个utf-8编码切片（将 unicode 大写、小写、标题三种格式字符视为相同）是否相同。

• Fields

func Fields(s []byte) [][]byte

返回将字符串按照空白（ unicode.IsSpace 确定，可以是一到多个连续的空白字符）分割的多个子切片。如果字符串全部是空白或者是空字符串的话，会返回空切片。

• FieldsFunc

func FieldsFunc(s []byte, f func(rune) bool) [][]byte

类似Fields，但使用函数f来确定分割符（满足f的utf-8码值）。如果字符串全部是分隔符或者是空字符串的话，会返回空切片。

• HasPrefix

func HasPrefix(s, prefix []byte) bool

判断s是否有前缀切片prefix。

• HasSuffix

func HasSuffix(s, suffix []byte) bool

判断s是否有后缀切片suffix。

• Index

func Index(s, sep []byte) int

子切片sep在s中第一次出现的位置，不存在则返回-1。

• IndexAny

func IndexAny(s []byte, chars string) int

字符串chars中的任一utf-8编码在s中第一次出现的位置，如不存在或者chars为空字符串则返回-1

• IndexByte

func IndexByte(s []byte, c byte) int

字符c在s中第一次出现的位置，不存在则返回-1

• IndexFunc

func IndexFunc(s []byte, f func(r rune) bool) int

s中第一个满足函数f的位置i（该处的utf-8码值r满足f®==true），不存在则返回-1

• IndexRune

func IndexRune(s []byte, r rune) int

unicode 字符r的utf-8编码在s中第一次出现的位置，不存在则返回-1。

• Join

func Join(s [][]byte, sep []byte) []byte

将一系列[]byte切片连接为一个[]byte切片，之间用sep来分隔，返回生成的新切片。

• LastIndex

func LastIndex(s, sep []byte) int

切片sep在字符串s中最后一次出现的位置，不存在则返回-1。

• LastIndexAny

func LastIndexAny(s []byte, chars string) int

字符串chars中的任一utf-8字符在s中最后一次出现的位置，如不存在或者chars为空字符串则返回-1。

• LastIndexFunc

func LastIndexFunc(s []byte, f func(r rune) bool) int

s中最后一个满足函数f的 unicode 码值的位置i，不存在则返回-1。

• Map

func Map(mapping func(r rune) rune, s []byte) []byte

将s的每一个 unicode 码值r都替换为mapping®，返回这些新码值组成的切片拷贝。如果mapping返回一个负值，将会丢弃该码值而不会被替换（返回值中对应位置将没有码值）。

• NewBuffer

func NewBuffer(buf []byte) *Buffer

NewBuffer使用buf作为初始内容创建并初始化一个Buffer。本函数用于创建一个用于读取已存在数据的buffer；也用于指定用于写入的内部缓冲的大小，此时，buf应为一个具有指定容量但长度为0的切片。buf会被作为返回值的底层缓冲切片。 大多数情况下，new(Buffer)（或只是声明一个Buffer类型变量）就足以初始化一个Buffer了。

• NewBufferString

func NewBufferString(s string) *Buffer

NewBuffer使用s作为初始内容创建并初始化一个Buffer。本函数用于创建一个用于读取已存在数据的buffer。 大多数情况下，new(Buffer)（或只是声明一个Buffer类型变量）就足以初始化一个Buffer了

• NewReader

func NewReader(b []byte) *Reader

NewReader创建一个从s读取数据的Reader。

• Repeat

func Repeat(b []byte, count int) []byte

返回count个b串联形成的新的切片。

• Replace

func Replace(s, old, new []byte, n int) []byte

返回将s中前n个不重叠old切片序列都替换为new的新的切片拷贝，如果n<0会替换所有old子切片。

• Runes

func Runes(s []byte) []rune

Runes函数返回和s等价的[]rune切片。（将utf-8编码的 unicode 码值分别写入单个rune）

• Split

func Split(s, sep []byte) [][]byte

用去掉s中出现的sep的方式进行分割，会分割到结尾，并返回生成的所有[]byte切片组成的切片（每一个sep都会进行一次切割，即使两个sep相邻，也会进行两次切割）。如果sep为空字符，Split会将s切分成每一个 unicode 码值一个[]byte切片

• SplitAfter

func SplitAfter(s, sep []byte) [][]byte

用从s中出现的sep后面切断的方式进行分割，会分割到结尾，并返回生成的所有[]byte切片组成的切片（每一个sep都会进行一次切割，即使两个sep相邻，也会进行两次切割）。如果sep为空字符，Split会将s切分成每一个 unicode 码值一个[]byte切片。

• SplitAfterN

func SplitAfterN(s, sep []byte, n int) [][]byte

用从s中出现的sep后面切断的方式进行分割，会分割到最多n个子切片，并返回生成的所有[]byte切片组成的切片（每一个sep都会进行一次切割，即使两个sep相邻，也会进行两次切割）。如果sep为空字符，Split会将s切分成每一个 unicode 码值一个[]byte切片。

参数n决定返回的切片的数目：
n>0:返回的切片最多n个子字符串；最后一个子字符串包含未进行切割的部分。
n==0:返回nil
n<0:返回所有的子字符串组成的切片

• SplitN

func SplitN(s, sep []byte, n int) [][]byte

用去掉s中出现的sep的方式进行分割，会分割到最多n个子切片，并返回生成的所有[]byte切片组成的切片（每一个sep都会进行一次切割，即使两个sep相邻，也会进行两次切割）。如果sep为空字符，Split会将s切分成每一个 unicode 码值一个[]byte切片。

参数n决定返回的切片的数目：
n>0:返回的切片最多n个子字符串；最后一个子字符串包含未进行切割的部分。
n==0:返回nil
n<0:返回所有的子字符串组成的切片

• Title

func Title(s []byte) []byte

返回s中每个单词的首字母都改为标题格式的拷贝。 BUG:Title用于划分单词的规则不能很好的处理Unicode标点符号。

• ToLower

func ToLower(s []byte) []byte

返回将所有字母都转为对应的小写版本的拷贝。

• ToLowerSpecial

func ToLowerSpecial(_case unicode.SpecialCase, s []byte) []byte

使用_case规定的字符映射，返回将所有字母都转为对应的小写版本的拷贝。

• ToTitle

func ToTitle(s []byte) []byte

返回将所有字母都转为对应的标题版本的拷贝。

• ToTitleSpecial

func ToTitleSpecial(_case unicode.SpecialCase, s []byte) []byte

使用_case规定的字符映射，返回将所有字母都转为对应的标题版本的拷贝。

• ToUpper

func ToUpper(s []byte) []byte

返回将所有字母都转为对应的大写版本的拷贝。

• ToUpperSpecial

func ToUpperSpecial(_case unicode.SpecialCase, s []byte) []byte

使用_case规定的字符映射，返回将所有字母都转为对应的大写版本的拷贝。

• Trim

func Trim(s []byte, cutset string) []byte

返回将s前后端所有cutset包含的 unicode 码值都去掉的子切片。（共用底层数组）

• TrimFunc

func TrimFunc(s []byte, f func(r rune) bool) []byte

返回将s前后端所有满足f的 unicode 码值都去掉的子切片。（共用底层数组）

• TrimLeft

func TrimLeft(s []byte, cutset string) []byte

返回将s前端所有cutset包含的 unicode 码值都去掉的子切片。（共用底层数组

• TrimLeftFunc

func TrimLeftFunc(s []byte, f func(r rune) bool) []byte

返回将s前端所有满足f的 unicode 码值都去掉的子切片。（共用底层数组）

• TrimPrefix

func TrimPrefix(s, prefix []byte) []byte

返回去除s可能的前缀prefix的子切片。（共用底层数组）

• TrimRight

func TrimRight(s []byte, cutset string) []byte

返回将s后端所有cutset包含的 unicode 码值都去掉的子切片。（共用底层数组）

• TrimRightFunc

func TrimRightFunc(s []byte, f func(r rune) bool) []byte

返回将s后端所有满足f的 unicode 码值都去掉的子切片。（共用底层数组）

• TrimSpace

func TrimSpace(s []byte) []byte

返回将s前后端所有空白（ unicode.IsSpace 指定）都去掉的子切片。（共用底层数组

• TrimSuffix

func TrimSuffix(s, suffix []byte) []byte

返回去除s可能的后缀suffix的子切片。（共用底层数组）

Example

这个包比较简单，就写几个简单的Demo

package main

import (
	"bytes"
	"fmt"
	"os"
)

func main() {
	readerExample()
	bufferExample()
}

func readerExample() {
	buf1 := bytes.NewBufferString("R29waGVycyBydWxlIQ==\n")
	//创建一个字节切片
	myByte := make([]byte, buf1.Len(), buf1.Len())
	reader := bytes.NewReader(buf1.Bytes())
	//从buf1第10个字节开始到最后一个字节，读取到myByte切片中
	n, err := reader.ReadAt(myByte, 10)
	if err != nil {
		fmt.Println(err.Error())
	} else {
		fmt.Println(n)
	}
	buf1.WriteTo(os.Stdout)
	fmt.Println(string(myByte))
}

func bufferExample() {
	// A Buffer needs no initialization.
	var b bytes.Buffer
	b.Write([]byte("Hello "))
	fmt.Println()
	b.WriteTo(os.Stdout)
	b.WriteByte('a')
	fmt.Println(b.Bytes())
	b.WriteTo(os.Stdout)
	fmt.Println(b.Bytes())
	b.WriteTo(os.Stdout)
}