Browse Source

CRandHex: fix up doc to mention length of digits

The previous doc seemed misleading and was out of date i.e.
RandHex(24)
not
CRandHex.

Anyways provide a doc of what the function does in relation to
the length of digits of the hex value returned i.e.
  floor(numDigits / 2) * 2
so the even lowest number
  e.g:
  * len(CRandHex(5)) = 4
  * len(CRandHex(4)) = 4
pull/1782/head
Emmanuel Odeke 7 years ago
parent
commit
62115b55ef
No known key found for this signature in database GPG Key ID: 1CA47A292F89DD40
1 changed files with 4 additions and 1 deletions
  1. +4
    -1
      random.go

+ 4
- 1
random.go View File

@ -44,7 +44,10 @@ func CRandBytes(numBytes int) []byte {
return b
}
// RandHex(24) gives 96 bits of randomness, strong enough for most purposes.
// CRandHex returns a hex encoded string that's floor(numDigits/2) * 2 long.
//
// Note: CRandHex(24) gives 96 bits of randomness that
// are usually strong enough for most purposes.
func CRandHex(numDigits int) string {
return hex.EncodeToString(CRandBytes(numDigits / 2))
}


Loading…
Cancel
Save