# cp.utf16.le

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

# API Overview

Functions - API calls offered directly by the extension

char
codepoint
codes
len
len
offset

# 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	`...` - The list of UCL codepoint integers to convert.
Returns	All the codepoints converted to UTF-16, concatonated into a string.
Notes	None
Examples	None
Source	src/extensions/cp/utf16/le.lua line 10

# 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	`s` - The string `i` - The starting index. Defaults to `1`. `j` - The ending index. Defaults to `i`.
Returns	a list of codepoint integers for all characters in the matching range.
Notes	None
Examples	None
Source	src/extensions/cp/utf16/le.lua line 21

# codes


Signature	`cp.utf16.le.codes(s) -> iterator`
Type	Function
Description	Returns values so that the construction
Parameters	`s` - The string to iterate through.
Returns	An iterator
Notes	For example: `lua</li><li> for p, c in utf16.codes(s) do body end</li><li>` will iterate over all characters in string `s`, with `p` being the position (in bytes) and `c` the code point of each character. It raises an error if it meets any invalid byte sequence.
Examples	None
Source	src/extensions/cp/utf16/le.lua line 34

# len


Signature	`cp.utf16.len (bigEndian, s [, i [, j]]) -> number \| boolean, number`
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	`bigEndian` - If true, the string is 'big-endian'. `s` - The UTF-16 string `i` - The starting index. Defaults to `1`. `j` - The ending index. Defaults to `-1`.
Returns	the length, or `false` and the first invalid byte index.
Notes	None
Examples	None
Source	src/extensions/cp/utf16/init.lua line 186

# len


Signature	`cp.utf16.le.len (s [, i [, j]]) -> number \| boolean, number`
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	`s` - The UTF-16 string `i` - The starting index. Defaults to `1`. `j` - The ending index. Defaults to `-1`.
Returns	the length, or `false` and the first invalid byte index.
Notes	None
Examples	None
Source	src/extensions/cp/utf16/le.lua line 53

# 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	`s` - The string `n` - The character number to find. `i` - The initial position to start from.
Returns	The index
Notes	As a special case, when `n` is 0 the function returns the start of the encoding of the character that contains the `i`-th byte of `s`. This function assumes that `s` is a valid UTF-16 string
Examples	None
Source	src/extensions/cp/utf16/le.lua line 66