Dateisystem

Das Modul fs liest, schreibt und verwaltet Dateien in konfigurierten Dateisystem-Volumes.

Diese Seite ist eine API-Referenz. Ihre Ausschnitte setzen ein konfiguriertes Volume und die Berechtigung voraus, es abzurufen. Jeder Block ist eine einzelne Operation oder ein Teilrezept; Anwendungswerte und Callbacks wie config, message, process und report_cleanup_error müssen bereits vorhanden sein. report_cleanup_error(err) zeichnet einen Fehler beim Schließen auf, ohne einen bereits aufgetretenen Operationsfehler zu ersetzen.

Informationen zur Dateisystemkonfiguration finden Sie unter Dateisystem.

Laden

local fs = require("fs")

Volume abrufen

Rufen Sie ein Dateisystem-Volume anhand seiner Registry-ID ab:

local vol, err = fs.get("app:storage")
if err then
    return nil, err
end

local content, read_err = vol:readfile("/config.json")
if read_err then return nil, read_err end
return content

Gibt zurück: FS, error

Dateien lesen

Gesamten Dateiinhalt lesen:

local json = require("json")

local vol, get_err = fs.get("app:config")
if get_err then return nil, get_err end

local data, err = vol:readfile("/settings.json")
if err then
    return nil, err
end

local config, decode_err = json.decode(data)
if decode_err then return nil, decode_err end
return config

Für große Dateien verwenden Sie Streaming mit open():

local errors = require("errors")

local file, err = vol:open("/data/large.csv", "r")
if err then
    return nil, err
end

while true do
    local chunk, err = file:read(65536)
    if err then
        if err:kind() == errors.NOT_FOUND then
            break -- EOF
        end
        local _, close_err = file:close()
        if close_err then report_cleanup_error(close_err) end
        return nil, err
    end
    process(chunk)
end

local _, close_err = file:close()
if close_err then return nil, close_err end

Dateien schreiben

Schreiben Sie eine Zeichenkette oder einen Reader-basierten Datenstrom in eine Datei:

local json = require("json")

local vol, get_err = fs.get("app:data")
if get_err then return nil, get_err end

-- Overwrite (default)
local encoded, encode_err = json.encode(config)
if encode_err then return nil, encode_err end
local _, write_err = vol:writefile("/config.json", encoded)
if write_err then return nil, write_err end

-- Append
local _, append_err = vol:writefile("/logs/app.log", message .. "\n", "a")
if append_err then return nil, append_err end

-- Exclusive write (fails if exists)
local ok, err = vol:writefile("/lock.pid", tostring(pid), "wx")
if err then return nil, err end

-- Copy from an open file or another reader-backed value
local source, err = vol:open("/incoming/report.csv", "r")
if err then
    return nil, err
end
local copied, err = vol:writefile("/archive/report.csv", source)
local _, close_err = source:close()
if err then
    if close_err then report_cleanup_error(close_err) end
    return nil, err
end
if close_err then return nil, close_err end
return copied

Verwenden Sie für Streaming-Schreibvorgänge ein Datei-Handle:

local file, open_err = vol:open("/output/report.txt", "w")
if open_err then return nil, open_err end
local _, header_err = file:write("Header\n")
if header_err then
    local _, close_err = file:close()
    if close_err then report_cleanup_error(close_err) end
    return nil, header_err
end
local _, data_err = file:write("Data: " .. value .. "\n")
if data_err then
    local _, close_err = file:close()
    if close_err then report_cleanup_error(close_err) end
    return nil, data_err
end
local _, sync_err = file:sync()
if sync_err then
    local _, close_err = file:close()
    if close_err then report_cleanup_error(close_err) end
    return nil, sync_err
end
local _, close_err = file:close()
if close_err then return nil, close_err end

Pfade prüfen

local vol, get_err = fs.get("app:data")
if get_err then return nil, get_err end

-- Check existence
local exists, exists_err = vol:exists("/cache/results.json")
if exists_err then return nil, exists_err end
if exists then
    return vol:readfile("/cache/results.json")
end

-- Check if directory
local is_dir, isdir_err = vol:isdir(path)
if isdir_err then return nil, isdir_err end
if is_dir then
    process_directory(path)
end

-- Get file info
local info, stat_err = vol:stat("/documents/report.pdf")
if stat_err then return nil, stat_err end
print(info.size, info.modified, info.type)

Stat-Felder: name, size, mode, modified, is_dir, type

Verzeichnisoperationen

local vol, get_err = fs.get("app:data")
if get_err then return nil, get_err end

-- Create directory
local _, mkdir_err = vol:mkdir("/uploads/" .. user_id)
if mkdir_err then return nil, mkdir_err end

-- List directory contents
local iter, state = vol:readdir("/documents")
if not iter then return nil, state end
for entry in iter, state do
    print(entry.name, entry.type)
end

-- Remove file or empty directory
local removed, remove_err = vol:remove("/temp/file.txt")
if remove_err then return nil, remove_err end
return removed

Eintrag-Felder: name, type ("file" oder "directory")

mkdir erstellt ein einzelnes Verzeichnis und legt fehlende übergeordnete Verzeichnisse nicht an. remove akzeptiert nur Dateien und leere Verzeichnisse.

Datei-Handle-Methoden

Bei Verwendung von vol:open() für Streaming:

Rufen Sie close() auf, wenn Sie mit einem Datei-Handle fertig sind.

Scanner

Für zeilenweise Verarbeitung:

local file, err = vol:open("/data/users.csv", "r")
if err then
    return nil, err
end
local scanner, err = file:scanner("lines")
if err then
    local _, close_err = file:close()
    if close_err then report_cleanup_error(close_err) end
    return nil, err
end

scanner:scan()  -- skip header

while scanner:scan() do
    local line = scanner:text()
    process(line)
end

local scan_err = scanner:err()
if scan_err then
    local _, close_err = file:close()
    if close_err then report_cleanup_error(close_err) end
    return nil, scan_err
end

local _, close_err = file:close()
if close_err then return nil, close_err end

Split-Modi: "lines" (Standard), "words", "bytes", "runes"

scanner:scan() gibt ausschließlich einen booleschen Wert zurück. Wenn das Ergebnis false ist, unterscheiden Sie mit scanner:err() ein reguläres Dateiende von einem Tokenisierungs- oder zugrunde liegenden Lesefehler. scanner:err() gibt einen strukturierten Fehler vom Typ INTERNAL oder nil zurück. Anders als ein Stream-Scanner besitzt ein Datei-Scanner keinen separaten Rückgabefehler für die Scan-Ausführung.

Konstanten

fs.type.FILE      -- "file"
fs.type.DIR       -- "directory"

fs.seek.SET       -- from start
fs.seek.CUR       -- from current
fs.seek.END       -- from end

FS-Methoden

Berechtigungen

Die Sicherheitsrichtlinie wird beim Abrufen eines Volumes ausgewertet.

Fehler

nicht angegeben bedeutet, dass err:retryable() den Wert nil zurückgibt; dies ist nicht gleichbedeutend mit false.

Informationen zum Umgang mit Fehlern finden Sie unter Fehlerbehandlung.