Модуль string

Модуль string включает в себя всё из стандартной библиотеки для работы со строками в Lua, а также некоторые расширения специально для Tarantool.

В данном разделе мы рассматриваем только дополнительные функции, добавленные разработчиками Tarantool.

Ниже приведен перечень всех функций библиотеки string.

Возврат строки, выровненной по левому краю, шириной, указанной в width.

Параметры:

• input-string (string) — строка для выравнивания по левому краю
• width (integer) — ширина строки после выравнивания по левому краю
• pad-character (string) — один символ, по умолчанию = 1 пробел

Возвращает

строку, выровненную по левому краю (без изменений, если width <= длины строки)

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.ljust(' A', 5)---- ' A   '...

Возврат строки, выровненной по правому краю, шириной, указанной в width.

Параметры:

• input-string (string) — строка для выравнивания по правому краю
• width (integer) — ширина строки после выравнивания по правому краю
• pad-character (string) — один символ, по умолчанию = 1 пробел

Возвращает

строку, выровненную по правому краю (без изменений, если width <= длины строки)

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.rjust('', 5, 'X')---- 'XXXXX'...

Возврат шестнадцатеричного значения введенной строки.

Параметры:

• input-string (string) — обрабатываемая строка

Возвращает

шестнадцатеричное значение, по 2 шестнадцатеричных символа на каждый символ входной строки

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.hex('ABC ')---- '41424320'...

Если передана строка, содержащая пары шестнадцатеричных цифр, возвращается строка с одним байтом для каждой пары. Это обратная операция к string.hex(). Строка hexadecimal-input-string должна содержать чётное количество шестнадцатеричных цифр.

Параметры:

• hexadecimal-input-string (string) — строка с парами шестнадцатеричных цифр

Возвращает

строку с одним байтом для каждой пары шестнадцатеричных цифр

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.fromhex('41424320')---- 'ABC '...

Возврат true (правда), если input-string начинается со start-string, в противном случае, возврат false (ложь).

Параметры:

• input-string (string) — строка, в которой выполняется поиск start-string
• start-string (string) — искомая строка
• start-pos (integer) — позиция, с которой начинается поиск в input-string
• end-pos (integer) — позиция, на которой заканчивается поиск в input-string

Возвращает

true или false

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

boolean

Значения start-pos и end-pos могут быть отрицательными, что означает, что положение вычисляется с конца строки.

Пример:

 
tarantool> string = require('string')---...tarantool> string.startswith(' A', 'A', 2, 5)---- true...

Возврат true (правда), если input-string заканчивается на end-string, в противном случае — возврат false (ложь).

Параметры:

• input-string (string) — строка, в которой выполняется поиск end-string
• end-string (string) — искомая строка
• start-pos (integer) — позиция, с которой начинается поиск в input-string
• end-pos (integer) — позиция, на которой заканчивается поиск в input-string

Возвращает

true или false

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

boolean

Значения start-pos и end-pos могут быть отрицательными — в этом случае позиция отсчитывается с конца строки.

Пример:

 
tarantool> string = require('string')---...tarantool> string.endswith('Baa', 'aa')---- true...

Возврат значения входной строки после удаления символов слева. Необязательный параметр list-of-characters задаёт множество, а не последовательность, поэтому string.lstrip(...,'ABC') означает удаление не 'ABC', а 'A' или 'B' или 'C'.

Параметры:

• input-string (string) — обрабатываемая строка

• list-of-characters (string) — символы, которые можно удалить. По умолчанию = пробел.

Возвращает

результат после удаления символов из входной строки

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.lstrip(' ABC ')---- 'ABC '...

Возврат значения входной строки после удаления символов справа. Необязательный параметр list-of-characters задаёт множество, а не последовательность, поэтому string.rstrip(...,'ABC') означает удаление не 'ABC', а 'A' или 'B' или 'C'.

Параметры:

• input-string (string) — обрабатываемая строка

• list-of-characters (string) — символы, которые можно удалить. По умолчанию = пробел.

Возвращает

результат после удаления символов из входной строки

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.rstrip(' ABC ')---- ' ABC'...

Разделение input-string на одну или более выводимых строк в таблице. Места разделения указаны в split-string.

Параметры:

• input-string (string) — разделяемая строка
• split-string (string) — строка, которую нужно найти в input-string. По умолчанию = пробел
• max (integer) — максимальное количество разделителей для обработки, отсчитываемое с начала входной строки. Результат будет содержать не более max + 1 частей

Возвращает

таблицу строк, полученных в результате разделения input-string

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

table

Пример:

 
tarantool> string = require('string')---...tarantool> string.split("A:B:C:D:F", ":", 2)---- - A  - B  - C:D:F...

Возврат значения входной строки после удаления символов слева и справа. Необязательный параметр list-of-characters задаёт множество, а не последовательность, поэтому string.strip(...,'ABC') означает удаление не 'ABC', а 'A' или 'B' или 'C'.

Параметры:

• input-string (string) — обрабатываемая строка

• list-of-characters (string) — символы, которые можно удалить. По умолчанию = пробел.

Возвращает

результат после удаления символов из входной строки

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

string

Пример:

 
tarantool> string = require('string')---...tarantool> string.strip(' ABC ')---- ABC...