Utf8.offset

From GiderosMobile
Revision as of 09:33, 9 February 2021 by MoKaLux (talk | contribs) (remove language stuff)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Available since: Gideros 2016.06
Class: utf8

Description

Returns the position (in bytes) where the encoding of the n-th character of s (counting from position i) starts.

(number) = utf8.offset(s,n,i)


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.

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-8 string.

Parameters

s: (string)
n: (number)
i: (number) optional

Return values

Returns (number) position (in bytes)