encoding
packagestandard libraryThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package encoding defines interfaces shared by other packages thatconvert data to and from byte-level and textual representations.Packages that check for these interfaces include encoding/gob,encoding/json, and encoding/xml. As a result, implementing aninterface once can make a type useful in multiple encodings.Standard types that implement these interfaces include time.Time and net.IP.The interfaces come in pairs that produce and consume encoded data.
Adding encoding/decoding methods to existing types may constitute a breaking change,as they can be used for serialization in communicating with programswritten with different library versions.The policy for packages maintained by the Go project is to only allowthe addition of marshaling functions if no existing, reasonable marshaling exists.
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
This section is empty.
Types¶
typeBinaryAppender¶added ingo1.24.0
type BinaryAppender interface {// AppendBinary appends the binary representation of itself to the end of b// (allocating a larger slice if necessary) and returns the updated slice.//// Implementations must not retain b, nor mutate any bytes within b[:len(b)].AppendBinary(b []byte) ([]byte,error)}
BinaryAppender is the interface implemented by an objectthat can append the binary representation of itself.If a type implements bothBinaryAppender andBinaryMarshaler,then v.MarshalBinary() must be semantically identical to v.AppendBinary(nil).
typeBinaryMarshaler¶
BinaryMarshaler is the interface implemented by an object that canmarshal itself into a binary form.
MarshalBinary encodes the receiver into a binary form and returns the result.
typeBinaryUnmarshaler¶
BinaryUnmarshaler is the interface implemented by an object that canunmarshal a binary representation of itself.
UnmarshalBinary must be able to decode the form generated by MarshalBinary.UnmarshalBinary must copy the data if it wishes to retain the dataafter returning.
typeTextAppender¶added ingo1.24.0
type TextAppender interface {// AppendText appends the textual representation of itself to the end of b// (allocating a larger slice if necessary) and returns the updated slice.//// Implementations must not retain b, nor mutate any bytes within b[:len(b)].AppendText(b []byte) ([]byte,error)}
TextAppender is the interface implemented by an objectthat can append the textual representation of itself.If a type implements bothTextAppender andTextMarshaler,then v.MarshalText() must be semantically identical to v.AppendText(nil).
typeTextMarshaler¶
TextMarshaler is the interface implemented by an object that canmarshal itself into a textual form.
MarshalText encodes the receiver into UTF-8-encoded text and returns the result.
typeTextUnmarshaler¶
TextUnmarshaler is the interface implemented by an object that canunmarshal a textual representation of itself.
UnmarshalText must be able to decode the form generated by MarshalText.UnmarshalText must copy the text if it wishes to retain the textafter returning.
Directories¶
Path | Synopsis |
---|---|
Package ascii85 implements the ascii85 data encoding as used in the btoa tool and Adobe's PostScript and PDF document formats. | Package ascii85 implements the ascii85 data encoding as used in the btoa tool and Adobe's PostScript and PDF document formats. |
Package asn1 implements parsing of DER-encoded ASN.1 data structures, as defined in ITU-T Rec X.690. | Package asn1 implements parsing of DER-encoded ASN.1 data structures, as defined in ITU-T Rec X.690. |
Package base32 implements base32 encoding as specified by RFC 4648. | Package base32 implements base32 encoding as specified by RFC 4648. |
Package base64 implements base64 encoding as specified by RFC 4648. | Package base64 implements base64 encoding as specified by RFC 4648. |
Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints. | Package binary implements simple translation between numbers and byte sequences and encoding and decoding of varints. |
Package csv reads and writes comma-separated values (CSV) files. | Package csv reads and writes comma-separated values (CSV) files. |
Package gob manages streams of gobs - binary values exchanged between an Encoder (transmitter) and a Decoder (receiver). | Package gob manages streams of gobs - binary values exchanged between an Encoder (transmitter) and a Decoder (receiver). |
Package hex implements hexadecimal encoding and decoding. | Package hex implements hexadecimal encoding and decoding. |
Package json implements encoding and decoding of JSON as defined in RFC 7159. | Package json implements encoding and decoding of JSON as defined in RFC 7159. |
jsontext Package jsontext implements syntactic processing of JSON as specified in RFC 4627, RFC 7159, RFC 7493, RFC 8259, and RFC 8785. | Package jsontext implements syntactic processing of JSON as specified in RFC 4627, RFC 7159, RFC 7493, RFC 8259, and RFC 8785. |
v2 Package json implements semantic processing of JSON as specified in RFC 8259. | Package json implements semantic processing of JSON as specified in RFC 8259. |
Package pem implements the PEM data encoding, which originated in Privacy Enhanced Mail. | Package pem implements the PEM data encoding, which originated in Privacy Enhanced Mail. |
Package xml implements a simple XML 1.0 parser that understands XML name spaces. | Package xml implements a simple XML 1.0 parser that understands XML name spaces. |