Zen

Source string Source string

209/10000 · 209
English Actions
Encode a string using the specified encoding options.
By default, ``uri.escape()`` uses encoding options defined by the :ref:`uri.RFC3986 <uri-rfc3986>` table. If required, you can customize encoding options using the ``uri_encoding_opts`` optional parameter, for example:
Pass the predefined set of options targeted for encoding a specific URI part (for example, :ref:`uri.PATH <uri-path>` or :ref:`uri.QUERY <uri-query>`).
Pass custom encoding options using the :ref:`uri_encoding_opts <uri_encoding_opts>` object.
a string to encode
encoding options (optional, see :ref:`uri_encoding_opts <uri_encoding_opts>`)
an encoded string
**Example 1:**
This example shows how to encode a string using the default encoding options.
local uri = require('uri')

escaped_string = uri.escape('C++')
--[[
---
- C%2B%2B
...
--]]
**Example 2:**
This example shows how to encode a string using the :ref:`uri.FORM_URLENCODED <uri-form-url-encoded>` encoding options.
local uri = require('uri')

escaped_string_url_enc = uri.escape('John Smith', uri.FORM_URLENCODED)
--[[
---
- John+Smith
...
--]]
**Example 3:**
This example shows how to encode a string using custom encoding options.
local uri = require('uri')

local escape_opts = {
plus = true,
unreserved = uri.unreserved("a-z")
}
escaped_string_custom = uri.escape('Hello World', escape_opts)
--[[
---
- '%48ello+%57orld'
...
--]]
Decode a string using the specified encoding options.
a string to decode
a decoded string
This example shows how to decode a string using the default encoding options.
local uri = require('uri')

unescaped_string = uri.unescape('C%2B%2B')
--[[
---
- C++
...
--]]
This example shows how to decode a string using the :ref:`uri.FORM_URLENCODED <uri-form-url-encoded>` encoding options.
local uri = require('uri')

unescaped_string_url_enc = uri.unescape('John+Smith', uri.FORM_URLENCODED)
--[[
---
- John Smith
...
--]]
This example shows how to decode a string using custom encoding options.
local uri = require('uri')

local escape_opts = {
plus = true,
unreserved = uri.unreserved("a-z")
}
unescaped_string_custom = uri.unescape('%48ello+%57orld', escape_opts)
--[[
---
- Hello World
...
--]]
Properties
Encoding options that use unreserved symbols defined in RFC 3986. These are default options used to encode and decode using the :ref:`uri.escape() <uri-escape>` and :ref:`uri.unescape() <uri-unescape>` functions, respectively.
**See also:** :ref:`uri_encoding_opts <uri_encoding_opts>`
Options used to encode the ``path`` URI component.
Options used to encode specific ``path`` parts.
Options used to encode the ``query`` URI component.

Loading…

User avatar None

New source string

testing_project / Documentation: reference/reference_lua/uri — English

local uri = require('uri')

local escape_opts = {
plus = true,
unreserved = uri.unreserved("a-z")
}
escaped_string_custom = uri.escape('Hello World', escape_opts)
--[[
---
- '%48ello+%57orld'
...
--]]
a year ago
Browse all string changes

Things to check

Ellipsis

The string uses three dots (...) instead of an ellipsis character (…)

Reset

Multiple unnamed variables

There are multiple unnamed variables in the string, making it impossible for translators to reorder them

Reset

Glossary

English English
No related strings found in the glossary.

String information

Flags
python-format, read-only
String age
a year ago
Last updated
a year ago
Source string age
a year ago
Translation file
string 71