Package utf8 implements functions and constants to support text encoded in UTF-8. It includes functions to translate between runes and UTF-8 byte sequences. See https://en.wikipedia.org/wiki/UTF-8

Static methods

staticinlineappendRune(_p:Slice<GoUInt8>, _r:GoInt32):Slice<GoUInt8>

AppendRune appends the UTF-8 encoding of r to the end of p and returns the extended buffer. If the rune is out of range, it appends the encoding of RuneError.

staticinlinedecodeLastRune(_p:Slice<GoUInt8>):{_1:GoInt, _0:GoInt32}

DecodeLastRune unpacks the last UTF-8 encoding in p and returns the rune and its width in bytes. If p is empty it returns (RuneError, 0). Otherwise, if the encoding is invalid, it returns (RuneError, 1). Both are impossible results for correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of range, or is not the shortest possible UTF-8 encoding for the value. No other validation is performed.

staticinlinedecodeLastRuneInString(_s:GoString):{_1:GoInt, _0:GoInt32}

DecodeLastRuneInString is like DecodeLastRune but its input is a string. If s is empty it returns (RuneError, 0). Otherwise, if the encoding is invalid, it returns (RuneError, 1). Both are impossible results for correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of range, or is not the shortest possible UTF-8 encoding for the value. No other validation is performed.

staticinlinedecodeRune(_p:Slice<GoUInt8>):{_1:GoInt, _0:GoInt32}

DecodeRune unpacks the first UTF-8 encoding in p and returns the rune and its width in bytes. If p is empty it returns (RuneError, 0). Otherwise, if the encoding is invalid, it returns (RuneError, 1). Both are impossible results for correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of range, or is not the shortest possible UTF-8 encoding for the value. No other validation is performed.

staticinlinedecodeRuneInString(_s:GoString):{_1:GoInt, _0:GoInt32}

DecodeRuneInString is like DecodeRune but its input is a string. If s is empty it returns (RuneError, 0). Otherwise, if the encoding is invalid, it returns (RuneError, 1). Both are impossible results for correct, non-empty UTF-8.

An encoding is invalid if it is incorrect UTF-8, encodes a rune that is out of range, or is not the shortest possible UTF-8 encoding for the value. No other validation is performed.

staticinlineencodeRune(_p:Slice<GoUInt8>, _r:GoInt32):GoInt

EncodeRune writes into p (which must be large enough) the UTF-8 encoding of the rune. If the rune is out of range, it writes the encoding of RuneError. It returns the number of bytes written.

staticinlinefullRune(_p:Slice<GoUInt8>):Bool

FullRune reports whether the bytes in p begin with a full UTF-8 encoding of a rune. An invalid encoding is considered a full Rune since it will convert as a width-1 error rune.

staticinlinefullRuneInString(_s:GoString):Bool

FullRuneInString is like FullRune but its input is a string.

staticinlineruneCount(_p:Slice<GoUInt8>):GoInt

RuneCount returns the number of runes in p. Erroneous and short encodings are treated as single runes of width 1 byte.

staticinlineruneCountInString(_s:GoString):GoInt

RuneCountInString is like RuneCount but its input is a string.

staticinlineruneLen(_r:GoInt32):GoInt

RuneLen returns the number of bytes required to encode the rune. It returns -1 if the rune is not a valid value to encode in UTF-8.

staticinlineruneStart(_b:GoUInt8):Bool

RuneStart reports whether the byte could be the first byte of an encoded, possibly invalid rune. Second and subsequent bytes always have the top two bits set to 10.

staticinlinevalid(_p:Slice<GoUInt8>):Bool

Valid reports whether p consists entirely of valid UTF-8-encoded runes.

staticinlinevalidRune(_r:GoInt32):Bool

ValidRune reports whether r can be legally encoded as UTF-8. Code points that are out of range or a surrogate half are illegal.

staticinlinevalidString(_s:GoString):Bool

ValidString reports whether s consists entirely of valid UTF-8-encoded runes.