Module: stdgo.unicode.utf8

(view library index)

Overview

Index

• Constants

• class Utf8

• function appendRune(_p:Array<UInt>, _r:Int):Array<UInt>

• function decodeLastRune(_p:Array<UInt>):stdgo.Tuple<Int, Int>

• function decodeLastRuneInString(_s:String):stdgo.Tuple<Int, Int>

• function decodeRune(_p:Array<UInt>):stdgo.Tuple<Int, Int>

• function decodeRuneInString(_s:String):stdgo.Tuple<Int, Int>

• function encodeRune(_p:Array<UInt>, _r:Int):Int

• function fullRune(_p:Array<UInt>):Bool

• function fullRuneInString(_s:String):Bool

• function runeCount(_p:Array<UInt>):Int

• function runeCountInString(_s:String):Int

• function runeLen(_r:Int):Int

• function runeStart(_b:UInt):Bool

• function valid(_p:Array<UInt>):Bool

• function validRune(_r:Int):Bool

• function validString(_s:String):Bool

• abstract T_acceptRange

Constants

import stdgo.unicode.utf8.Utf8

final maxRune:Int = stdgo._internal.unicode.utf8.Utf8_maxRune.maxRune

final runeError:Int = stdgo._internal.unicode.utf8.Utf8_runeError.runeError

final runeSelf:haxe.UInt64 = stdgo._internal.unicode.utf8.Utf8_runeSelf.runeSelf

final utfmax:haxe.UInt64 = stdgo._internal.unicode.utf8.Utf8_utfmax.utfmax

Classes

import stdgo.unicode.utf8.*

class Utf8

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

Utf8 function appendRune

function appendRune(_p:Array<UInt>, _r:Int):Array<UInt>

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.

(view code)

Utf8 function decodeLastRune

function decodeLastRune(_p:Array<UInt>):stdgo.Tuple<Int, Int>

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.

(view code)

Utf8 function decodeLastRuneInString

function decodeLastRuneInString(_s:String):stdgo.Tuple<Int, Int>

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.

(view code)

Utf8 function decodeRune

function decodeRune(_p:Array<UInt>):stdgo.Tuple<Int, Int>

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.

(view code)

Utf8 function decodeRuneInString

function decodeRuneInString(_s:String):stdgo.Tuple<Int, Int>

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.

(view code)

Utf8 function encodeRune

function encodeRune(_p:Array<UInt>, _r:Int):Int

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.

(view code)

Utf8 function fullRune

function fullRune(_p:Array<UInt>):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.

(view code)

Utf8 function fullRuneInString

function fullRuneInString(_s:String):Bool

FullRuneInString is like FullRune but its input is a string.

(view code)

Utf8 function runeCount

function runeCount(_p:Array<UInt>):Int

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

(view code)

Utf8 function runeCountInString

function runeCountInString(_s:String):Int

RuneCountInString is like RuneCount but its input is a string.

(view code)

Utf8 function runeLen

function runeLen(_r:Int):Int

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.

(view code)

Utf8 function runeStart

function runeStart(_b:UInt):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.

(view code)

Utf8 function valid

function valid(_p:Array<UInt>):Bool

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

(view code)

Utf8 function validRune

function validRune(_r:Int):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.

(view code)

Utf8 function validString

function validString(_s:String):Bool

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

(view code)

Abstracts

abstract T_acceptRange

(view file containing code)