proquint

README

Proquint

Golang implementation of Proquint Pronounceable Identifiers.

Documentation

Index

• func Decode(str string) []byte
• func Encode(buf []byte) string
• func IsProquint(str string) (bool, error)

Functions

func Decode

func Decode(str string) []byte

* * Decodes an identifier into its corresponding byte slice. * * @param {string} str Identifier to convert. * * @return {[]byte} The identifier as a byte slice.

func Encode

func Encode(buf []byte) string

* * Encodes an arbitrary byte slice into an identifier. * * @param {[]byte} buf Slice of bytes to encode. * * @return {string} The given byte slice as an identifier.

func IsProquint

func IsProquint(str string) (bool, error)

* * Tests if a given string is a Proquint identifier * * @param {string} str The candidate string. * * @return {bool} Whether or not it qualifies. * @return {error} Error