README.md

Base45 encoder/decoder for Go

A small and simple package to encode and decode Base45 data.

It implements the current RFC 9285 with additional testing.

The target is to keep a somewhat optimized version with readable code.

Usage

The following example app illustrates the usage:

package main

import (
	"fmt"
	"github.com/adrianrudnik/base45-go"
)

func main() {
	// Encoding data
	encoded := base45.Encode([]byte("Hello!!"))
	fmt.Printf("Encoded: %s\n", encoded)

	urlEncoded := base45.EncodeURLSafe([]byte("Hello!!"))
	fmt.Printf("Encoded url safe: %s\n", urlEncoded)

	// Decoding data
	decoded, err := base45.Decode([]byte("%69 VD92EX0"))
	fmt.Printf("Decoded: %s, Error: %v\n", decoded, err)

	urlDecoded, err := base45.DecodeURLSafe("%2569%20VD92EX0")
	fmt.Printf("Decoded url safe: %s, Error: %v\n", urlDecoded, err)

	// Error handling
	_, err = base45.Decode([]byte("GGW"))

	if err == base45.ErrInvalidEncodedDataOverflow {
		fmt.Printf("Encountered invalid data")
	}
}

Performance

Encoding is measured on input bytes. Decoding is measured on output bytes.

cpu: Intel(R) Core(TM) i7-6700K CPU @ 4.00GHz
BenchmarkEncode1-8              53352907                22.51 ns/op            2 B/op          1 allocs/op
BenchmarkEncode128-8             1000000              1128 ns/op             256 B/op          1 allocs/op
BenchmarkEncode512-8              266653              4457 ns/op            1024 B/op          1 allocs/op
BenchmarkEncode1024-8             134896              8899 ns/op            2048 B/op          1 allocs/op
BenchmarkEncode8192-8              16968             70802 ns/op           16384 B/op          1 allocs/op
BenchmarkDecode1-8              28283660                42.38 ns/op            2 B/op          1 allocs/op
BenchmarkDecode128-8              425233              2797 ns/op             192 B/op          1 allocs/op
BenchmarkDecode512-8              102676             11959 ns/op             768 B/op          1 allocs/op
BenchmarkDecode1024-8              49183             23954 ns/op            1536 B/op          1 allocs/op
BenchmarkDecode8192-8               5810            194933 ns/op           12288 B/op          1 allocs/op