package encoding

import "encoding"

Package encoding 定义了其他包共享的接口, 用于在数据和字节级与文本级表示之间进行转换。 检查这些接口的包包括 encoding/gob、encoding/json 和 encoding/xml。 因此,实现一个接口一次即可让某个类型在多种编码中发挥作用。 实现这些接口的标准类型包括 time.Time 和 net.IP。 这些接口成对出现,分别负责生成和消费编码后的数据。

向现有类型添加编码/解码方法可能构成破坏性变更, 因为它们可能被用于与使用不同库版本编写的程序进行通信时的序列化。 Go 项目维护的包的政策是,只有在不存在现有且合理的编组方式时, 才允许添加编组函数。

Index

Types

type BinaryAppender

type BinaryAppender interface {
	// AppendBinary 将自身的二进制表示追加到 b 的末尾
	// (如有必要会分配更大的切片)并返回更新后的切片。
	//
	// 实现不得保留 b,也不得修改 b[:len(b)] 内的任何字节。
	AppendBinary(b []byte) ([]byte, error)
}

BinaryAppender 是由能够追加自身二进制表示的对象实现的接口。 如果某个类型同时实现了 BinaryAppender 和 BinaryMarshaler, 那么 v.MarshalBinary() 必须在语义上等同于 v.AppendBinary(nil)。

type BinaryMarshaler

type BinaryMarshaler interface {
	MarshalBinary() (data []byte, err error)
}

BinaryMarshaler 是由能够将自身编组为二进制形式的对象实现的接口。

MarshalBinary 将接收者编码为二进制形式并返回结果。

type BinaryUnmarshaler

type BinaryUnmarshaler interface {
	UnmarshalBinary(data []byte) error
}

BinaryUnmarshaler 是由能够反编组自身二进制表示的对象实现的接口。

UnmarshalBinary 必须能够解码由 MarshalBinary 生成的形式。 如果 UnmarshalBinary 希望在返回后保留数据,则必须复制该数据。

type TextAppender

type TextAppender interface {
	// AppendText 将自身的文本表示追加到 b 的末尾
	// (如有必要会分配更大的切片)并返回更新后的切片。
	//
	// 实现不得保留 b,也不得修改 b[:len(b)] 内的任何字节。
	AppendText(b []byte) ([]byte, error)
}

TextAppender 是由能够追加自身文本表示的对象实现的接口。 如果某个类型同时实现了 TextAppender 和 TextMarshaler, 那么 v.MarshalText() 必须在语义上等同于 v.AppendText(nil)。

type TextMarshaler

type TextMarshaler interface {
	MarshalText() (text []byte, err error)
}

TextMarshaler 是由能够将自身编组为文本形式的对象实现的接口。

MarshalText 将接收者编码为 UTF-8 编码的文本并返回结果。

type TextUnmarshaler

type TextUnmarshaler interface {
	UnmarshalText(text []byte) error
}

TextUnmarshaler 是由能够反编组自身文本表示的对象实现的接口。

UnmarshalText 必须能够解码由 MarshalText 生成的形式。 如果 UnmarshalText 希望在返回后保留文本,则必须复制该文本。

Directories

ascii85 Package ascii85 实现 ascii85 数据编码, 该编码用于 btoa 工具以及 Adobe 的 PostScript 和 PDF 文档格式。
asn1 Package asn1 实现 DER 编码的 ASN.1 数据结构的解析, 其定义见 ITU-T Rec X.690。
base32 Package base32 实现 RFC 4648 所规定的 base32 编码。
base64 Package base64 实现 RFC 4648 所规定的 base64 编码。
binary Package binary 实现了数字与字节序列之间的简单转换,以及 varint 的编码和解码。
csv Package csv 读取和写入逗号分隔值(CSV)文件。
gob Package gob 管理 gob 流——在 Encoder(发送方)与 Decoder(接收方)之间交换的 二进制值。
hex Package hex 实现十六进制编码和解码。
json 包 json 实现了 RFC 7159 中定义的 JSON 的编码与解码。
pem Package pem 实现 PEM 数据编码,该编码源自隐私增强邮件(Privacy Enhanced Mail)。
xml Package xml 实现了一个简单的 XML 1.0 解析器, 它能理解 XML 命名空间。