Difference between revisions of "Utf8.find"
| (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 === | ||
| − | + | Looks for the first match of pattern in the string s. | |
| − | + | <syntaxhighlight lang="lua"> | |
| − | < | ||
(numbers) = utf8.find(s,pattern,init,plain) | (numbers) = utf8.find(s,pattern,init,plain) | ||
| − | </ | + | </syntaxhighlight> |
| + | |||
| + | If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil. | ||
| + | |||
| + | A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative. | ||
| + | |||
| + | A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered magic. Note that if plain is given, then init must be given as well. | ||
| + | |||
| + | If the pattern has captures, then in a successful match the captured values are also returned, after the two indices. | ||
| + | |||
=== Parameters === | === Parameters === | ||
| − | '''s''': (string) | + | '''s''': (string) <br/> |
| − | '''pattern''': (string) | + | '''pattern''': (string) <br/> |
| − | '''init''': (number) | + | '''init''': (number) '''optional'''<br/> |
| − | '''plain''': (boolean) | + | '''plain''': (boolean) '''optional'''<br/> |
| + | |||
=== Return values === | === Return values === | ||
| − | '''Returns''' (numbers) | + | '''Returns''' (numbers) the indices of s where this occurrence starts and ends; otherwise, it returns nil<br/> |
| + | |||
| + | {{Utf8}} | ||
Latest revision as of 21:46, 1 December 2023
Available since: Gideros 2016.06
Class: utf8
Description
Looks for the first match of pattern in the string s.
(numbers) = utf8.find(s,pattern,init,plain)
If it finds a match, then find returns the indices of s where this occurrence starts and ends; otherwise, it returns nil.
A third, optional numerical argument init specifies where to start the search; its default value is 1 and can be negative.
A value of true as a fourth, optional argument plain turns off the pattern matching facilities, so the function does a plain "find substring" operation, with no characters in pattern being considered magic. Note that if plain is given, then init must be given as well.
If the pattern has captures, then in a successful match the captured values are also returned, after the two indices.
Parameters
s: (string)
pattern: (string)
init: (number) optional
plain: (boolean) optional
Return values
Returns (numbers) the indices of s where this occurrence starts and ends; otherwise, it returns nil
