A pure-LUA implementation of UTF-16 decoding with little-endian ordering.

API Overview

API Documentation

Functions

char

Signature

cp.utf16.le.char(...) -> string

Type

Function

Description

Receives zero or more integers, converts each one to its corresponding UTF-16 byte sequence and returns a string with the concatenation of all these sequences.

Parameters

Returns

codepoint

Signature

cp.utf16.le.codepoint(s [, i [, j]]) -> integer...

Type

Function

Description

Returns the codepoints (as integers) from all characters in s that start between byte position i and j (both included). The default for i is 1 and for j is i. It raises an error if it meets any invalid byte sequence.

Parameters

Returns

codes

Signature

cp.utf16.le.codes(s) -> iterator

Type

Function

Description

Returns values so that the construction

Parameters

Returns

len

Signature

`cp.utf16.len (bigEndian, s [, i [, j]]) -> number

boolean, number` </span>

Type

Function

Description

Returns the number of UTF-16 characters in string s that start between positions i and j (both inclusive). The default for i is 1 and for j is -1. If it finds any invalid byte sequence, returns a false value plus the position of the first invalid byte.

Parameters

Returns

len

Signature

`cp.utf16.le.len (s [, i [, j]]) -> number

boolean, number` </span>

Type

Function

Description

Returns the number of UTF-16 characters in string s that start between positions i and j (both inclusive). The default for i is 1 and for j is -1. If it finds any invalid byte sequence, returns a false value plus the position of the first invalid byte.

Parameters

Returns

offset

Signature

cp.utf16.le.offset (s, n [, i]) -> number

Type

Function

Description

Returns the position (in bytes) where the encoding of the n-th character of s (counting from position i) starts. A negative n gets characters before position i. The default for i is 1 when n is non-negative and #s + 1 otherwise, so that utf8.offset(s, -n) gets the offset of the n-th character from the end of the string. If the specified character is neither in the subject nor right after its end, the function returns nil.

Parameters

Returns