Difference between revisions of "Utf8.offset"
From GiderosMobile
| Line 2: | Line 2: | ||
'''Available since:''' Gideros 2016.06<br/> | '''Available since:''' Gideros 2016.06<br/> | ||
=== Description === | === Description === | ||
| − | Returns the position (in bytes) where the encoding of the n-th character of s (counting from position i) starts. 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. | + | <translate>Returns the position (in bytes) where the encoding of the n-th character of s (counting from position i) starts. 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. | 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. | + | This function assumes that s is a valid UTF-8 string.</translate> |
<source lang="lua"> | <source lang="lua"> | ||
(number) = utf8.offset(s,n,i) | (number) = utf8.offset(s,n,i) | ||
</source> | </source> | ||
=== Parameters === | === Parameters === | ||
| − | '''s''': (string) | + | '''s''': (string) <translate></translate> <br/> |
| − | '''n''': (number) | + | '''n''': (number) <translate></translate> <br/> |
| − | '''i''': (number) | + | '''i''': (number) <translate></translate> '''optional'''<br/> |
=== Return values === | === Return values === | ||
| − | '''Returns''' (number) position (in bytes)<br/> | + | '''Returns''' (number) <translate>position (in bytes)</translate><br/> |
Revision as of 13:34, 23 August 2018
Available since: Gideros 2016.06
Description
Returns the position (in bytes) where the encoding of the n-th character of s (counting from position i) starts. 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.
(number) = utf8.offset(s,n,i)
Parameters
s: (string)
n: (number)
i: (number) optional
Return values
Returns (number) position (in bytes)
