proquint

package
v0.4.1-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 20, 2016 License: MIT Imports: 3 Imported by: 0

README

Proquint

Golang implementation of Proquint Pronounceable Identifiers.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL