EMILUA(3em)

hey bestie!! welcome to the EMILUA(3em) page — it’s part of the Emilua reference, and Emilua is your Lua execution engine 💅✨

✨ NAME ✨

Emilua — Lua execution engine 🧚💜

🦋 SYNOPSIS 🦋

local fs = require "filesystem"
fs.open(path: fs.path, flags: string[][, mode: integer]) -> file_descriptor

💖 DESCRIPTION 💖

Open the file using the specified path. You hand it path, and it gives you a file_descriptor — slay 🎀

Behind the scenes, the implementation for this function always includes the flag O_NOCTTY — no cap, it’s just in there 🔥

flags may contain these values:

• "append" — opens the file in append mode.
• "create" — creates the file if it does not exist.

Note: this one requires the mode argument. Example: fs.mode(7, 7, 7).

• "directory" — fails if path resolves to a non-directory file.
• "exclusive" — ensures a new file gets created. Must be combined with "create".
• "no_follow" — fails if path resolves to a symbolic link.
• "path" — gets a stable reference to an inode without actually opening the contents.
• "read_only" — opens the file for reading.
• "read_write" — opens the file for reading and writing.
• "sync_all_on_write" — opens the file so that write operations automatically synchronise the file data and metadata to disk (FILE_FLAG_WRITE_THROUGH/O_SYNC).
• "temporary" — creates an unnamed temporary regular file.

Note: this one requires the mode argument. Example: fs.mode(7, 7, 7).

• "truncate" — opens the file with any existing contents truncated.
• "write_only" — opens the file for writing.

Note: not available on Windows.

🌈 SEE ALSO 🌈

• file.stream(3em) — go check that one out too, bestie 🦋

okay byeee bestie — source/version Emilua 0.12.1-nixpkgs1, date 1980-01-01 🫶💅