Difference between revisions of "Utf8.gmatch"
From GiderosMobile
(5 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
'''Available since:''' Gideros 2016.06<br/> | '''Available since:''' Gideros 2016.06<br/> | ||
+ | '''Class:''' [[utf8]]<br/> | ||
+ | |||
=== Description === | === Description === | ||
− | + | Returns an iterator function that, each time it is called, returns the next captures from pattern over the string ''s''. | |
− | + | <syntaxhighlight lang="lua"> | |
− | < | ||
(function) = utf8.gmatch(s,pattern) | (function) = utf8.gmatch(s,pattern) | ||
− | </ | + | </syntaxhighlight> |
+ | |||
+ | If pattern specifies no captures, then the whole match is produced in each call. | ||
+ | |||
+ | For this function, a caret '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration. | ||
+ | |||
=== Parameters === | === Parameters === | ||
− | '''s''': (string) | + | '''s''': (string) <br/> |
− | '''pattern''': (string) | + | '''pattern''': (string) <br/> |
+ | |||
=== Return values === | === Return values === | ||
− | '''Returns''' (function) | + | '''Returns''' (function) iterator function<br/> |
+ | |||
+ | {{Utf8}} |
Latest revision as of 21:50, 1 December 2023
Available since: Gideros 2016.06
Class: utf8
Description
Returns an iterator function that, each time it is called, returns the next captures from pattern over the string s.
(function) = utf8.gmatch(s,pattern)
If pattern specifies no captures, then the whole match is produced in each call.
For this function, a caret '^' at the start of a pattern does not work as an anchor, as this would prevent the iteration.
Parameters
s: (string)
pattern: (string)
Return values
Returns (function) iterator function