encoding/gob: document that structs only encode/decode exported fields

Fixes #4579.

R=golang-dev, minux.ma
CC=golang-dev
https://golang.org/cl/7000051
This commit is contained in:
Russ Cox 2012-12-22 10:43:47 -05:00
parent 407d0c5ab7
commit d324c4af87
1 changed files with 7 additions and 5 deletions

View File

@ -67,11 +67,13 @@ point values may be received into any floating point variable. However,
the destination variable must be able to represent the value or the decode
operation will fail.
Structs, arrays and slices are also supported. Strings and arrays of bytes are
supported with a special, efficient representation (see below). When a slice is
decoded, if the existing slice has capacity the slice will be extended in place;
if not, a new array is allocated. Regardless, the length of the resulting slice
reports the number of elements decoded.
Structs, arrays and slices are also supported. Structs encode and
decode only exported fields. Strings and arrays of bytes are supported
with a special, efficient representation (see below). When a slice
is decoded, if the existing slice has capacity the slice will be
extended in place; if not, a new array is allocated. Regardless,
the length of the resulting slice reports the number of elements
decoded.
Functions and channels cannot be sent in a gob. Attempting
to encode a value that contains one will fail.