This library provides basic support for `UTF-8` encoding. This library does
not provide any support for Unicode other than the handling of the encoding.
Any operation that needs the meaning of a character, such as character
classification, is outside its scope.

Unless stated otherwise, all functions that expect a byte position as a
parameter assume that the given position is either the start of a byte
sequence or one plus the length of the subject string. As in the string
library, negative indices count from the end of the string.

You can find a large catalog of usable `UTF-8`characters
[here](https://www.w3schools.com/charsets/ref_html_utf8.asp).


Receives zero or more codepoints as integers, converts each one to its
corresponding UTF-8 byte sequence and returns a string with the
concatenation of all these sequences.


utf8.char

codepoints

Converts zero or more codepoints to UTF-8 byte sequences.


Returns an iterator function so that the construction:

```lua
for position, codepoint in utf8.codes(str) do
	-- body
end
```

will iterate over all codepoints in string `str`. It raises an error if it
meets any invalid byte sequence.


utf8.codes

Returns an iterator function that iterates over all codepoints in a given
string.


Returns the codepoints (as integers) from all codepoints in the provided
string (str) that start between byte positions `i` and `j` (both
included). The default for `i` is `1` and for `j` is `i`. It raises an
error if it meets any invalid byte sequence.


utf8.codepoint

The index of the codepoint that should be fetched from this string.


The index of the last codepoint between `i` and `j` that will be
returned. If excluded, this will default to the value of `i`.


Returns the codepoints (as integers) from all codepoints in a given
string.


Returns the number of UTF-8 codepoints in the string _str_ that start
between positions `i` and `j` (both inclusive). The default for `i` is `1`
and for `j` is `-1`. If it finds any invalid byte sequence, returns a nil
value plus the position of the first invalid byte.


utf8.len

Returns the number of UTF-8 codepoints in a given string.


Returns the position (in bytes) where the encoding of the n-th codepoint
of `s` (counting from byte 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`.


utf8.offset

Returns the position (in bytes) where the encoding of the n-th codepoint
of `s` (counting from byte position `i`) starts.


Returns an iterator function so that

```lua
for first, last in utf8.graphemes(str) do
	local grapheme = s:sub(first, last)
	-- body
end
```

will iterate the grapheme clusters of the string.


utf8.graphemes

Returns an iterator function that iterates over the grapheme clusters of a
given string.


Converts the input string to Normal Form C, which tries to convert
decomposed characters into composed characters.


utf8.nfcnormalize

Converts the input string to Normal Form C.


Converts the input string to Normal Form D, which tries to break up
composed characters into decomposed characters.


utf8.nfdnormalize

Converts the input string to Normal Form D.


utf8

The pattern `"[%z\x01-\x7F\xC2-\xF4][\x80-\xBF]*"`, which matches exactly
zero or more UTF-8 byte sequence, assuming that the subject is a valid
UTF-8 string.


utf8.charpattern

This library provides basic support for `UTF-8` encoding.


Default Value: {defaultValueStart}{defaultValueEnd}

This function returns immediately if possible, but can yield the thread that called it until it can return a value.

This member doesn’t appear in the object browser and is not intended for widespread use.

This member is only accessible only through the command bar. Attempting to access this member from scripts causes an error.

This function can’t pause the Lua thread that called it.

Attempting to access this member in scripts causes an error. You might be able to access this member from Roblox Studio's property window.

This member doesn’t appear in Roblox Studio’s Object Browser.

You can’t create an instance of this class with the Instance.new constructor.

Roblox does not replicate this member across its server-client boundary.

Lua code can’t access this member. You might be able to change its value from the property window in Roblox Studio.

This object’s replication behavior is dependent on the player who owns it.

This member is accessible only through the command bar and plugins only. Attempting to access this member from scripts causes an error.

This property is read-only and is safe to read in unsynchronized threads. Attempting to write to it causes an error.

This member is read only. Attempting to write to this member causes an error.

This member is accessible only in CoreScripts.

Only Roblox CoreScripts can access this member, and it isn’t usable by Players.

You can read and write to this property safely from multiple threads.

This class is a top-level singleton. Retrieve an instance of this class with the GetService function.

Multiple threads can potentially write to this property, so it’s unsafe to read from unsynchronized threads.

This function pauses the Lua thread that called it until it returns a result. This doesn’t interrupt other scripts.

{pageTitle} | {SiteName}

We’re making things more awesome. Thanks for your patience.

By clicking "Continue", you will be directed to {redirectLinkStart}{redirectLinkEnd}

This site is not owned or operated by Roblox. They may have different terms and privacy policies.

utf8

Summary

Functions

Properties

Functions

char

Parameters

Returns

codes

Parameters

Returns

codepoint

Parameters

Returns

len

Parameters

Returns

offset

Parameters

Returns

graphemes

Parameters

Returns

nfcnormalize

Parameters

Returns

nfdnormalize

Parameters

Returns

Properties

charpattern