Utf8.offset

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)

---

• Utf8
• Utf8.byte
• Utf8.char
• Utf8.charpattern
• Utf8.charpos
• Utf8.codepoint
• Utf8.codes
• Utf8.escape
• Utf8.find
• Utf8.fold
• Utf8.gmatch
• Utf8.gsub
• Utf8.insert
• Utf8.len
• Utf8.lower
• Utf8.match
• Utf8.ncasecmp
• Utf8.next
• Utf8.offset
• Utf8.remove
• Utf8.reverse
• Utf8.sub
• Utf8.title
• Utf8.upper
• Utf8.width
• Utf8.widthindex

---

---

• Main Page
• Lua API
• Main API
• Plugins