cesu8

Documentation

Overview

Package cesu8 implements functions and constants to support text encoded in CESU-8. It implements functions comparable to the unicode/utf8 package for UTF-8 de- and encoding.

Index

• Constants
• func DecodeRune(p []byte) (rune, int)
• func EncodeRune(p []byte, r rune) int
• func FullRune(p []byte) bool
• func RuneLen(r rune) int
• func Size(p []byte) int
• func StringSize(s string) int

Constants

const (
	// CESUMax is the maximum amount of bytes used by an CESU-8 codepoint encoding.
	CESUMax = 6
)

Functions

func DecodeRune

func DecodeRune(p []byte) (rune, int)

DecodeRune unpacks the first CESU-8 encoding in p and returns the rune and its width in bytes.

func EncodeRune

func EncodeRune(p []byte, r rune) int

EncodeRune writes into p (which must be large enough) the CESU-8 encoding of the rune. It returns the number of bytes written.

func FullRune

func FullRune(p []byte) bool

FullRune reports whether the bytes in p begin with a full CESU-8 encoding of a rune.

func RuneLen

func RuneLen(r rune) int

RuneLen returns the number of bytes required to encode the rune.

func Size

func Size(p []byte) int

Size returns the amount of bytes needed to encode an UTF-8 byte slice to CESU-8.

func StringSize

func StringSize(s string) int

StringSize is like Size with a string as parameter.