Версия:

Модуль uri

Модуль uri

Общие сведения

URI – это Унифицированный идентификатор ресурса (Uniform Resource Identifier). Согласно стандарту IETF, URI-строка выглядит следующим образом:

[схема:]специальная-часть-схемы[#фрагмент]

Общий тип, иерархический URI, выглядит так:

[схема:][//адрес][путь][?запрос][#фрагмент]

Например, строка 'https://tarantool.org/x.html#y' содержит три компонента:

  • https – схема,
  • tarantool.org/x.html – путь,
  • y – фрагмент.

Модуль Tarantool’а URI включает в себя процедуры для разложения URI-строк на компоненты или объединения компонентов в URI-строку.

Индекс

Ниже приведен перечень всех функций модуля uri.

Имя Использование
uri.parse() Получение таблицы URI-компонентов
uri.format() Создание URI из компонентов
uri.parse(URI-string)
Параметры:
  • URI-string – Унифицированный идентификатор ресурса
возвращается:

таблица с компонентами URI. Доступные компоненты: fragment (фрагмент), host (хост), login (имя для входа), password (пароль), path (путь), query (запрос), scheme (схема), service (сервис).

тип возвращаемого значения:
 

Таблица

Пример:

tarantool> uri = require('uri')
 ---
 ...

 tarantool> uri.parse('http://x.html#y')
 ---
 - host: x.html
   scheme: http
   fragment: y
 ...
uri.format(URI-components-table[, include-password])
Параметры:
  • URI-components-table – ряд пар ключ-значение, одна для каждого компонента
  • include-password – boolean. If this is supplied and is true, then the password component is rendered in clear text, otherwise it is omitted.
возвращается:

URI-строка. Таким образом, uri.format() – это операция, обратная uri.parse().

тип возвращаемого значения:
 

string (строка)

Пример:

tarantool> uri.format({host = 'x.html', scheme = 'http', fragment = 'y'})
 ---
 - http://x.html#y
 ...