base256

README

base256

🌀 Binary to emoji encoding.

Install

$ go get -u ekyu.moe/base256
# or better
$ dep ensure -add ekyu.moe/base256

Example

package main

import (
    "fmt"

    "ekyu.moe/base256"
)

func main() {
    fmt.Println(base256.EncodeToString([]byte("Hello, 世界")))   //=> 👾🍧🙆🍬🙇🌱😌🚟💦🏥🐴🏤👈
    fmt.Println(string(base256.DecodeString("👾🍧🙆🍬🙇🌱😌🚟💦🏥🐴🏤👈"))) //=> Hello, 世界
}

Check godoc for further documents.

A CLI utility is also available with go get ekyu.moe/base256/cmd/base256.

Specification

base256 encoding uses two tables to transform a single byte into a single emoji. The tables can be found in table.go. In this implementation, these tables are utilized circularly when encoding, however such rule does not apply to decoding.

To achieve the best compatibility, all the emojis are picked from the classic version and each of them is 4 bytes long in UTF-8.

License

BSD-3-clause

Documentation

Index

• func DecodeString(s string) []byte
• func EncodeToString(src []byte) string
• func NewDecoder(r io.Reader) io.Reader
• func NewEncoder(w io.Writer) io.WriteCloser

Functions

func DecodeString

func DecodeString(s string) []byte

DecodeString returns the bytes represented by the base256 string s. Non-base256 runes are skipped silently.

func EncodeToString

func EncodeToString(src []byte) string

EncodeToString returns the encoded base256 string of src.

func NewDecoder

func NewDecoder(r io.Reader) io.Reader

NewDecoder constructs a new base256 stream decoder. Data read from the returned reader is base256 decoded from r. Non-base256 runes are skipped silently.

func NewEncoder

func NewEncoder(w io.Writer) io.WriteCloser

NewEncoder returns a new base256 stream encoder. Data written to the returned writer will be encoded using base256 and then written to w. When finished writing, the caller must Close the returned encoder to flush any partially written blocks.