diff options
| author | Dmytro Yeroshkin <yeroshkin@google.com> | 2024-12-06 15:49:52 +0000 |
|---|---|---|
| committer | Gopher Robot <gobot@golang.org> | 2024-12-06 20:49:45 +0000 |
| commit | 35caf4130eafaafb0f30bb4feeeb61ed0df37596 (patch) | |
| tree | b5fc9b1be00e5223fc81d747de0f07a618a20d5e /src | |
| parent | f0b8d79c96be6f8557fd8b42d51996327cf1ecdc (diff) | |
| download | go-35caf4130eafaafb0f30bb4feeeb61ed0df37596.tar.xz | |
encoding/base64, encoding/base32: add doc details to DecodeString and AppendDecode
Currently only Encoding.Decode has the information that `\r` and
`\n` are ignored. However, this also applies to the other decoding
methods. Since this is not intuitive behavior, we should add this
information to the other impacted methods.
Change-Id: I6f71fe1f4280fe75f2694a3cc1b759652eb8b8c1
Reviewed-on: https://go-review.googlesource.com/c/go/+/634215
Reviewed-by: Ian Lance Taylor <iant@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Chris Ingram <chrisingram@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
Reviewed-by: Truc Le <trucleduc@google.com>
Diffstat (limited to 'src')
| -rw-r--r-- | src/encoding/base32/base32.go | 3 | ||||
| -rw-r--r-- | src/encoding/base64/base64.go | 3 |
2 files changed, 6 insertions, 0 deletions
diff --git a/src/encoding/base32/base32.go b/src/encoding/base32/base32.go index 66f24e98a6..8bda6c6799 100644 --- a/src/encoding/base32/base32.go +++ b/src/encoding/base32/base32.go @@ -401,6 +401,7 @@ func (enc *Encoding) Decode(dst, src []byte) (n int, err error) { // AppendDecode appends the base32 decoded src to dst // and returns the extended buffer. // If the input is malformed, it returns the partially decoded src and an error. +// New line characters (\r and \n) are ignored. func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error) { // Compute the output size without padding to avoid over allocating. n := len(src) @@ -415,6 +416,8 @@ func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error) { } // DecodeString returns the bytes represented by the base32 string s. +// If the input is malformed, it returns the partially decoded data and +// [CorruptInputError]. New line characters (\r and \n) are ignored. func (enc *Encoding) DecodeString(s string) ([]byte, error) { buf := []byte(s) l := stripNewlines(buf, buf) diff --git a/src/encoding/base64/base64.go b/src/encoding/base64/base64.go index 7f0fa2de78..f94bea132c 100644 --- a/src/encoding/base64/base64.go +++ b/src/encoding/base64/base64.go @@ -409,6 +409,7 @@ func (enc *Encoding) decodeQuantum(dst, src []byte, si int) (nsi, n int, err err // AppendDecode appends the base64 decoded src to dst // and returns the extended buffer. // If the input is malformed, it returns the partially decoded src and an error. +// New line characters (\r and \n) are ignored. func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error) { // Compute the output size without padding to avoid over allocating. n := len(src) @@ -423,6 +424,8 @@ func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error) { } // DecodeString returns the bytes represented by the base64 string s. +// If the input is malformed, it returns the partially decoded data and +// [CorruptInputError]. New line characters (\r and \n) are ignored. func (enc *Encoding) DecodeString(s string) ([]byte, error) { dbuf := make([]byte, enc.DecodedLen(len(s))) n, err := enc.Decode(dbuf, []byte(s)) |