package base32
import "encoding/base32"
Package base32 实现 RFC 4648 所规定的 base32 编码。
Index
- Constants
- Variables
- func NewDecoder(enc *Encoding, r io.Reader) io.Reader
- func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
- type CorruptInputError
-
type Encoding
- func NewEncoding(encoder string) *Encoding
- func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error)
- func (enc *Encoding) AppendEncode(dst, src []byte) []byte
- func (enc *Encoding) Decode(dst, src []byte) (n int, err error)
- func (enc *Encoding) DecodeString(s string) ([]byte, error)
- func (enc *Encoding) DecodedLen(n int) int
- func (enc *Encoding) Encode(dst, src []byte)
- func (enc *Encoding) EncodeToString(src []byte) string
- func (enc *Encoding) EncodedLen(n int) int
- func (enc Encoding) WithPadding(padding rune) *Encoding
Examples
Constants
const ( StdPadding rune = '=' // 标准填充字符 NoPadding rune = -1 // 无填充 )
Variables
var HexEncoding = NewEncoding("0123456789ABCDEFGHIJKLMNOPQRSTUV")
HexEncoding 是 RFC 4648 中定义的 "扩展十六进制字母表"。 它通常用于 DNS。
var StdEncoding = NewEncoding("ABCDEFGHIJKLMNOPQRSTUVWXYZ234567")
StdEncoding 是 RFC 4648 中定义的标准 base32 编码。
Functions
func NewDecoder
func NewDecoder(enc *Encoding, r io.Reader) io.Reader
NewDecoder 构造一个新的 base32 流解码器。
func NewEncoder
func NewEncoder(enc *Encoding, w io.Writer) io.WriteCloser
NewEncoder 返回一个新的 base32 流编码器。写入返回的 writer 的数据
将使用 enc 编码,然后写入 w。
Base32 编码以 5 字节块为操作单位;写入完成后,
调用者必须 Close 返回的编码器,以刷新任何
部分写入的块。
Output:Example
package main
import (
"encoding/base32"
"os"
)
func main() {
input := []byte("foo\x00bar")
encoder := base32.NewEncoder(base32.StdEncoding, os.Stdout)
encoder.Write(input)
// Must close the encoder when finished to flush any partial blocks.
// If you comment out the following line, the last partial block "r"
// won't be encoded.
encoder.Close()
}
MZXW6ADCMFZA====
Types
type CorruptInputError
type CorruptInputError int64
func (CorruptInputError) Error
func (e CorruptInputError) Error() string
type Encoding
type Encoding struct { // contains filtered or unexported fields }
Encoding 是一种基数 32 的编码/解码方案,由 32 个字符的字母表定义。 最常见的是为 SASL GSSAPI 引入并在 RFC 4648 中标准化的 "base32" 编码。 另一种 "base32hex" 编码用于 DNSSEC。
func NewEncoding
func NewEncoding(encoder string) *Encoding
NewEncoding 返回一个新的带填充的 Encoding,由给定的字母表定义, 该字母表必须是包含唯一字节值的 32 字节字符串, 且不包含填充字符或 CR / LF('\r'、'\n')。 字母表被视为字节值序列,对多字节 UTF-8 不做任何特殊处理。 生成的 Encoding 使用默认填充字符('='), 可通过 Encoding.WithPadding 更改或禁用。
func (*Encoding) AppendDecode
func (enc *Encoding) AppendDecode(dst, src []byte) ([]byte, error)
AppendDecode 将 base32 解码后的 src 追加到 dst 并返回扩展后的缓冲区。 如果输入格式错误,它返回部分解码的 src 和一个错误。 换行字符(\r 和 \n)会被忽略。
func (*Encoding) AppendEncode
func (enc *Encoding) AppendEncode(dst, src []byte) []byte
AppendEncode 将 base32 编码后的 src 追加到 dst 并返回扩展后的缓冲区。
func (*Encoding) Decode
func (enc *Encoding) Decode(dst, src []byte) (n int, err error)
Decode 使用编码 enc 解码 src。它最多向 dst 写入
Encoding.DecodedLen(len(src)) 个字节,并返回写入的字节数。
调用者必须确保 dst 足够大以容纳所有解码后的数据。
如果 src 包含无效的 base32 数据,它会返回成功写入的
字节数以及 CorruptInputError。
换行字符(\r 和 \n)会被忽略。
Output:Example
package main
import (
"encoding/base32"
"fmt"
)
func main() {
str := "JBSWY3DPFQQHO33SNRSCC==="
dst := make([]byte, base32.StdEncoding.DecodedLen(len(str)))
n, err := base32.StdEncoding.Decode(dst, []byte(str))
if err != nil {
fmt.Println("decode error:", err)
return
}
dst = dst[:n]
fmt.Printf("%q\n", dst)
}
"Hello, world!"
func (*Encoding) DecodeString
func (enc *Encoding) DecodeString(s string) ([]byte, error)
DecodeString 返回 base32 字符串 s 所表示的字节。
如果输入格式错误,它返回部分解码的数据以及
CorruptInputError。换行字符(\r 和 \n)会被忽略。
Output:Example
package main
import (
"encoding/base32"
"fmt"
)
func main() {
str := "ONXW2ZJAMRQXIYJAO5UXI2BAAAQGC3TEEDX3XPY="
data, err := base32.StdEncoding.DecodeString(str)
if err != nil {
fmt.Println("error:", err)
return
}
fmt.Printf("%q\n", data)
}
"some data with \x00 and \ufeff"
func (*Encoding) DecodedLen
func (enc *Encoding) DecodedLen(n int) int
DecodedLen 返回与 n 字节 base32 编码数据相对应的 已解码数据的最大字节长度。
func (*Encoding) Encode
func (enc *Encoding) Encode(dst, src []byte)
Encode 使用编码 enc 对 src 进行编码, 向 dst 写入 Encoding.EncodedLen(len(src)) 个字节。
该编码将输出填充到 8 字节的倍数,
因此 Encode 不适合用于大型数据流的单个块。
请改用 NewEncoder。
Output:Example
package main
import (
"encoding/base32"
"fmt"
)
func main() {
data := []byte("Hello, world!")
dst := make([]byte, base32.StdEncoding.EncodedLen(len(data)))
base32.StdEncoding.Encode(dst, data)
fmt.Println(string(dst))
}
JBSWY3DPFQQHO33SNRSCC===
func (*Encoding) EncodeToString
func (enc *Encoding) EncodeToString(src []byte) string
EncodeToString 返回 src 的 base32 编码。
Output:Example
package main
import (
"encoding/base32"
"fmt"
)
func main() {
data := []byte("any + old & data")
str := base32.StdEncoding.EncodeToString(data)
fmt.Println(str)
}
MFXHSIBLEBXWYZBAEYQGIYLUME======
func (*Encoding) EncodedLen
func (enc *Encoding) EncodedLen(n int) int
EncodedLen 返回长度为 n 的输入缓冲区 的 base32 编码的字节长度。
func (Encoding) WithPadding
func (enc Encoding) WithPadding(padding rune) *Encoding
WithPadding 创建一个新的编码,除使用指定的填充字符外与 enc 相同, 或使用 NoPadding 禁用填充。 填充字符不能是 '\r' 或 '\n', 不能包含在编码的字母表中, 不能为负数,且必须是等于或小于 '\xff' 的 rune。 高于 '\x7f' 的填充字符按其准确的字节值编码, 而不是使用该码点的 UTF-8 表示。