puny

README

puny

Package puny provides functions for encoding/decoding to/from punycode.

Install

go get -u gitlab.com/golang-commonmark/puny

Documentation

Overview

Package puny provides functions for encoding/decoding to/from punycode.

Index

• Variables
• func Decode(s string) (string, error)
• func Encode(input string) (string, error)
• func ToASCII(s string) string
• func ToUnicode(s string) string

Variables

var (
	ErrOverflow     = errors.New("overflow: input needs wider integers to process")
	ErrNotBasic     = errors.New("illegal input >= 0x80 (not a basic code point)")
	ErrInvalidInput = errors.New("invalid input")
)

Functions

func Decode

func Decode(s string) (string, error)

Decode converts a Punycode string of ASCII-only symbols to a string of Unicode symbols.

func Encode

func Encode(input string) (string, error)

Encode converts a string of Unicode symbols (e.g. a domain name label) to a Punycode string of ASCII-only symbols.

func ToASCII

func ToASCII(s string) string

ToASCII converts a Unicode string representing a domain name or an email address to Punycode. Only the non-ASCII parts of the domain name will be converted.

func ToUnicode

func ToUnicode(s string) string

ToUnicode converts a Punycode string representing a domain name or an email address to Unicode. Only the Punycoded parts of the input will be converted.