qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-25 18:17:56 -07:00
Code Releases Activity

encoding/binary: adjust docs for Append, Encode and Decode

Browse Source 
Updates #60023

Change-Id: Ida1cc6c4f5537402e11db6b8c411828f2bcc0a5e
Reviewed-on: https://go-review.googlesource.com/c/go/+/587096
Reviewed-by: Austin Clements <austin@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
This commit is contained in:
Jes Cok 2024-05-22 00:07:01 +08:00 committed by Austin Clements
parent cbd8f16adc
commit 6f08665079
1 changed files with 9 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/encoding/binary/binary.go
View File

@ -272,9 +272,9 @@ func Read(r io.Reader, order ByteOrder, data any) error {
return nil
}
// Decode binary data from buf into data according to the given byte order.
//
// Returns an error if buf is too small, otherwise the number of
// Decode decodes binary data from buf into data according to
// the given byte order.
// It returns an error if buf is too small, otherwise the number of
// bytes consumed from buf.
func Decode(buf []byte, order ByteOrder, data any) (int, error) {
if n, _ := intDataSize(data); n != 0 {
@ -415,10 +415,10 @@ func Write(w io.Writer, order ByteOrder, data any) error {
return err
}
// Encode the binary representation of data into buf according to the given byte order.
//
// Returns an error if the buffer is too short, otherwise the number of bytes
// written into buf.
// Encode encodes the binary representation of data into buf according to
// the given byte order.
// It returns an error if buf is too small, otherwise the number of
// bytes written into buf.
func Encode(buf []byte, order ByteOrder, data any) (int, error) {
// Fast path for basic types and slices.
if n, _ := intDataSize(data); n != 0 {
@ -445,12 +445,10 @@ func Encode(buf []byte, order ByteOrder, data any) (int, error) {
return size, nil
}
// Append the binary representation of data to buf.
//
// Append appends the binary representation of data to buf.
// buf may be nil, in which case a new buffer will be allocated.
// See [Write] on which data are acceptable.
//
// Returns the (possibily extended) buffer containing data or an error.
// It returns the (possibily extended) buffer containing data or an error.
func Append(buf []byte, order ByteOrder, data any) ([]byte, error) {
// Fast path for basic types and slices.
if n, _ := intDataSize(data); n != 0 {