1
0
mirror of https://github.com/golang/go synced 2024-10-02 16:28:34 -06:00

encoding/hex: Document DecodedLen.

Mention that it specifically returns x / 2, and do the same for
EncodedLen.

Change-Id: Ie334f5abecbc487caf4965abbcd14442591bef2a
Change-Id: Idfa413faad487e534489428451bf736b009293d6
Reviewed-on: https://go-review.googlesource.com/33191
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
This commit is contained in:
Thordur Bjornsson 2016-11-12 17:05:17 +01:00 committed by Brad Fitzpatrick
parent 582a421a8c
commit afa68b36cc

View File

@ -18,6 +18,7 @@ var hextable = [16]byte{
} }
// EncodedLen returns the length of an encoding of n source bytes. // EncodedLen returns the length of an encoding of n source bytes.
// Specifically, it returns n * 2.
func EncodedLen(n int) int { return n * 2 } func EncodedLen(n int) int { return n * 2 }
// Encode encodes src into EncodedLen(len(src)) // Encode encodes src into EncodedLen(len(src))
@ -43,6 +44,8 @@ func (e InvalidByteError) Error() string {
return fmt.Sprintf("encoding/hex: invalid byte: %#U", rune(e)) return fmt.Sprintf("encoding/hex: invalid byte: %#U", rune(e))
} }
// DecodedLen returns the length of a decoding of x source bytes.
// Specifically, it returns x / 2.
func DecodedLen(x int) int { return x / 2 } func DecodedLen(x int) int { return x / 2 }
// Decode decodes src into DecodedLen(len(src)) bytes, // Decode decodes src into DecodedLen(len(src)) bytes,