aboutsummaryrefslogtreecommitdiff
path: root/src/encoding/hex/hex.go
diff options
context:
space:
mode:
authorEmmanuel Odeke <emm.odeke@gmail.com>2016-09-04 03:49:02 -0700
committerBrad Fitzpatrick <bradfitz@golang.org>2016-09-08 19:51:01 +0000
commit141f1a0e24836abbc85933787025edef260fe1f0 (patch)
tree9040623ffd08ab452f3b283ad9e84d1a39a25a2f /src/encoding/hex/hex.go
parent4354ffd38b7ebdf7b4ee9ff614939ed77f872acd (diff)
downloadgo-141f1a0e24836abbc85933787025edef260fe1f0.tar.xz
encoding/hex: implement examples using all exported functions
Fixes #11254. Updates #16360. Implements examples using all exported functions. This CL also updates Decode documentation to state that only hexadecimal characters are accepted in the source slice src, but also that the length of src must be even. Change-Id: Id016a4ba814f940cd300f26581fb4b9d2aded306 Reviewed-on: https://go-review.googlesource.com/28482 Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org> Run-TryBot: Brad Fitzpatrick <bradfitz@golang.org>
Diffstat (limited to 'src/encoding/hex/hex.go')
-rw-r--r--src/encoding/hex/hex.go7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/encoding/hex/hex.go b/src/encoding/hex/hex.go
index 0211d23a18..8c2334871d 100644
--- a/src/encoding/hex/hex.go
+++ b/src/encoding/hex/hex.go
@@ -45,10 +45,11 @@ func (e InvalidByteError) Error() string {
func DecodedLen(x int) int { return x / 2 }
-// Decode decodes src into DecodedLen(len(src)) bytes, returning the actual
-// number of bytes written to dst.
+// Decode decodes src into DecodedLen(len(src)) bytes,
+// returning the actual number of bytes written to dst.
//
-// If Decode encounters invalid input, it returns an error describing the failure.
+// Decode expects that src contain only hexadecimal
+// characters and that src should have an even length.
func Decode(dst, src []byte) (int, error) {
if len(src)%2 == 1 {
return 0, ErrLength