README
¶
GED - Global-purpose Encoding / Decoding library
This library lets you use common encoding/decoding schemes and allows you to define custom ones.
Use standard hex encoding/decoding:
encoded := ged.EncodeHex([]byte("Hello World"))
// => 48656c6c6f20576f726c64
decoded, err := ged.DecodeHex(encoded)
// => Hello World
Use standard base58 encoding/decoding:
encoded := ged.Encode58([]byte("Hello World"))
// => JxF12TrwUP45BMd
decoded, err := ged.Decode58(encoded)
// => Hello World
Use a custom encoding:
alphabet := alphabet.MustCreate("ABCD1234")
encoded := ged.EncodeString([]byte("Hello World"), alphabet)
// => 11B12DDA33B24BAA2D224D1133B11
decoded, err := ged.DecodeString(encoded, alphabet)
// => Hello World
Documentation
¶
Overview ¶
Package ged implements a global-purpose encoding/decoding library.
Index ¶
- func Decode(data []byte, baseFrom uint) ([]byte, error)
- func Decode58(encoded string) ([]byte, error)
- func DecodeHex(encoded string) ([]byte, error)
- func DecodeString(encoded string, alphabet alphabet.Alphabet) ([]byte, error)
- func Encode(data []byte, baseTo uint) []byte
- func Encode58(data []byte) string
- func EncodeHex(data []byte) string
- func EncodeString(data []byte, alphabet alphabet.Alphabet) string
- func Transform(data []byte, baseFrom, baseTo uint) ([]byte, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Decode58 ¶
DecodeBase58 decodes string from a base58 representation using the Bitcoin alphabet.
func DecodeString ¶
DecodeString decodes string using the provided alphabet.
func EncodeString ¶
EncodeString encodes data using a provided alphabet.
func Transform ¶
Transform is a low-level generic function to transform bytes from a given base to a target base. Returns an error if an element in data is greater or equal than the given base: if the baseFrom is 128, then all elements from data must be lower than 128. baseFrom and baseTo SHOULD NOT be greater than 256 and MUST NOT be lower than 2.
Types ¶
This section is empty.
Source Files
Directories