ファイルシステム

fs モジュールは、構成済みのファイルシステムボリューム内でファイルを読み取り、書き込み、管理します。

このページは API リファレンスです。スニペットでは、構成済みのボリュームと、そのボリュームを取得する権限を前提としています。各ブロックは独立した操作または部分的なレシピです。config、message、process、report_cleanup_error などのアプリケーション値やコールバックは、あらかじめ存在している必要があります。report_cleanup_error(err) は、すでに発生した操作エラーを置き換えずにクローズの失敗を記録します。

ファイルシステムの構成については、ファイルシステムを参照してください。

ロード

local fs = require("fs")

ボリュームの取得

レジストリIDでファイルシステムボリュームを取得:

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

戻り値: FS, error

ファイルの読み取り

ファイル内容全体を読み取り:

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

大きなファイルには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

ファイルの書き込み

文字列またはリーダーが供給するストリームをファイルに書き込みます:

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

ストリーミング書き込みにはファイルハンドルを使用します:

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

パスのチェック

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 フィールド: name、size、mode、modified、is_dir、type

ディレクトリ操作

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

Entry フィールド: name、type（"file" または "directory"）

mkdir は 1 つのディレクトリを作成しますが、存在しない親ディレクトリは作成しません。remove が対象にできるのは、ファイルと空のディレクトリだけです。

ファイルハンドルメソッド

ストリーミング用にvol:open()を使用する場合:

ファイルハンドルの使用が終わったら close() を呼び出してください。

スキャナ

行単位の処理:

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

スプリットモード: "lines"（デフォルト）、"words"、"bytes"、"runes"

scanner:scan() はブール値だけを返します。false が返された場合は scanner:err() を呼び出し、正常な EOF と、トークン化または基盤の読み取りの失敗を区別してください。scanner:err() は構造化された INTERNAL エラーまたは nil を返します。ストリームスキャナとは異なり、ファイルスキャナには独立したスキャンディスパッチエラーの戻り値はありません。

定数

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

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

FSメソッド

権限

ボリュームの取得時に、セキュリティポリシーが評価されます。

エラー

unspecified は err:retryable() が nil を返すことを意味します。false と同じではありません。

エラーの処理については、エラー処理を参照してください。