Utf8.next

Available since: Gideros 2016.06
Class: utf8

Description

Iterates through the UTF-8 string s.

(varies) = utf8.next(s,charpos,offset)

If only s is given, it can used as a iterator:

for pos, code in utf8.next, "utf8-string" do
-- ...
end

If only charpos is given, returns the next byte offset of in string.

If charpos and offset are given, a new charpos will be calculated, by add/subtract UTF-8 char offset to current charpos.

In all cases, it returns a new char position (in bytes), and code point (a number) at this position.

Parameters

s: (string)
charpos: (number) optional
offset: (number) optional

Return values

Returns (varies) next iteration

---

• 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