BigBigDoudou / binenc

:key: A short go packgage to encode array of strings to binary and decode binary to array of strings, based on a "key".

binenc

A binary encoder that encodes a list of strings into a integer basing on a key. This is useful if you need to persist a combination of options and can not afford to save an array in database.

The enconding bases on a array of strings which is the key to encode and decode. Changing the key will break the decoding. It should contain 64 strings or less. Providing a key with more than 64 strings returns a error on Encode call. The encoder generates a uniq code for each of the 18446744073709551615 combinations (for 64 strings) and can then decode it to return the original combination.

package main

import (
	"binenc"
	"fmt"
	"strconv"
)

func main() {
	key := binenc.Key{"alfa", "bravo", "charlie", "delta", "echo", "foxtrot", "golf"}

	encoded, _ := key.Encode([]string{"bravo", "delta", "foxtrot"})
	decoded := key.Decode(42)

	fmt.Println(encoded)                       // 42     (base 10)
	fmt.Println(strconv.FormatInt(encoded, 2)) // 0101010 (base 2)
	fmt.Println(decoded)                       // [bravo delta foxtrot]
}