store — datafile

Чтение и запись .lua-файлов. Формат читаемый и правится руками, поэтому

datafile

Чтение и запись .lua-файлов. Формат читаемый и правится руками, поэтому подходит для того, что редактирует человек: список админов, набор префиксов, сток магазина. Им же ядро хранит data/users.lua.

Запись атомарна. Новое содержимое пишется в .tmp, старый файл переезжает в .bak, и только потом .tmp встаёт на место. Вывод детерминированный: ключи сортируются, две записи одних и тех же данных дают побайтово одинаковый файл.

datafile.at

Привязывает модуль к своему каталогу.

datafile.at(dir)

Аргументы

#	имя	тип
1	dir	string	существующий каталог

Возвращает

тип
table	тот же набор функций, но в этом каталоге

Пример

local files = require("datafile").at(plugin.data_dir())

Без at() функции работают в общем addons/lua/data/, где лежит users.lua ядра.

datafile.load

Читает таблицу из <dir>/<name>.lua.

datafile.load(name[, fallback])

Аргументы

#	имя	тип
1	name	string	имя файла без расширения
2	fallback	any	что вернуть, если файла нет

Возвращает

тип
table	содержимое файла
string	причина, если файл битый

Отсутствие файла — не ошибка: на свежем сервере данных ещё нет. Битый файл — ошибка, и она возвращается вторым значением.

Файл выполняется в пустом окружении: ни io, ни os, ни print. Всё, кроме возвращённой таблицы, — ошибка.

datafile.save

Пишет таблицу в <dir>/<name>.lua.

datafile.save(name, t[, header])

Аргументы

#	имя	тип
1	name	string	имя файла без расширения
2	t	table	что записать
3	header	string | nil	комментарий первой строкой

Возвращает

тип
boolean	true при успехе
string	причина при ошибке

datafile.serialize

Превращает таблицу в текст, без записи.

datafile.serialize(t)

Аргументы

#	имя	тип
1	t	table	что сериализовать

Возвращает

тип
string	Lua-литерал

datafile.dir

Каталог, к которому привязан модуль.

datafile.dir()

Возвращает

тип
string	абсолютный путь