summaryrefslogtreecommitdiff
path: root/vendor/codeberg.org/gruf/go-hashenc/enc.go
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/codeberg.org/gruf/go-hashenc/enc.go')
-rw-r--r--vendor/codeberg.org/gruf/go-hashenc/enc.go10
1 files changed, 5 insertions, 5 deletions
diff --git a/vendor/codeberg.org/gruf/go-hashenc/enc.go b/vendor/codeberg.org/gruf/go-hashenc/enc.go
index 39b342843..0cc8d5986 100644
--- a/vendor/codeberg.org/gruf/go-hashenc/enc.go
+++ b/vendor/codeberg.org/gruf/go-hashenc/enc.go
@@ -6,7 +6,7 @@ import (
"encoding/hex"
)
-// Encoder defines an interface for encoding binary data
+// Encoder defines an interface for encoding binary data.
type Encoder interface {
// Encode encodes the data at src into dst
Encode(dst []byte, src []byte)
@@ -15,22 +15,22 @@ type Encoder interface {
EncodedLen(int) int
}
-// Base32 returns a new base32 Encoder
+// Base32 returns a new base32 Encoder (StdEncoding, no padding).
func Base32() Encoder {
return base32.StdEncoding.WithPadding(base64.NoPadding)
}
-// Base64 returns a new base64 Encoder
+// Base64 returns a new base64 Encoder (URLEncoding, no padding).
func Base64() Encoder {
return base64.URLEncoding.WithPadding(base64.NoPadding)
}
-// Hex returns a new hex Encoder
+// Hex returns a new hex Encoder.
func Hex() Encoder {
return &hexEncoder{}
}
-// hexEncoder simply provides an empty receiver to satisfy Encoder
+// hexEncoder simply provides an empty receiver to satisfy Encoder.
type hexEncoder struct{}
func (*hexEncoder) Encode(dst []byte, src []byte) {