fs

import fs

Functions

Function	Signature	Description
read_text	(String) -> Result[String, String]	Read file contents as a UTF-8 string
read_bytes	(String) -> Result[List[Int], String]	Read file contents as a list of bytes
write	(String, String) -> Result[Unit, String]	Write a string to a file, creating or overwriting it
write_bytes	(String, List[Int]) -> Result[Unit, String]	Write a list of bytes to a file
append	(String, String) -> Result[Unit, String]	Append a string to a file, creating it if it doesn’t exist
mkdir_p	(String) -> Result[Unit, String]	Create a directory and all parent directories
exists	(String) -> Bool	Check if a file or directory exists
read_lines	(String) -> Result[List[String], String]	Read a file as a list of lines
remove	(String) -> Result[Unit, String]	Delete a file
list_dir	(String) -> Result[List[String], String]	List entries in a directory
is_dir	(String) -> Bool	Check if a path is a directory
is_file	(String) -> Bool	Check if a path is a regular file
copy	(String, String) -> Result[Unit, String]	Copy a file from src to dst
rename	(String, String) -> Result[Unit, String]	Rename or move a file
walk	(String) -> Result[List[String], String]	Recursively list all files in a directory tree
remove_all	(String) -> Result[Unit, String]	Recursively delete a directory and all its contents
file_size	(String) -> Result[Int, String]	Get file size in bytes
temp_dir	() -> String	Get the system temporary directory path
stat	(String) -> Result[{size: Int, is_dir: Bool, is_file: Bool, modified: Int}, String]	Get file metadata: size, type, and modification time
glob	(String) -> Result[List[String], String]	Find files matching a glob pattern
create_temp_file	(String) -> Result[String, String]	Create a temporary file with a given prefix, return its path
create_temp_dir	(String) -> Result[String, String]	Create a temporary directory with a given prefix, return its path
is_symlink	(String) -> Bool	Check if a path is a symbolic link
modified_at	(String) -> Result[Int, String]	Get file modification time as Unix timestamp (seconds)

Reference

fs.read_text(path: String) -> Result[String, String]

Read file contents as a UTF-8 string

let text = fs.read_text("config.toml")

fs.read_bytes(path: String) -> Result[List[Int], String]

Read file contents as a list of bytes

let bytes = fs.read_bytes("image.png")

fs.write(path: String, content: String) -> Result[Unit, String]

Write a string to a file, creating or overwriting it

fs.write("output.txt", "hello")

fs.write_bytes(path: String, bytes: List[Int]) -> Result[Unit, String]

Write a list of bytes to a file

fs.write_bytes("out.bin", [0, 1, 2])

fs.append(path: String, content: String) -> Result[Unit, String]

Append a string to a file, creating it if it doesn’t exist

fs.append("log.txt", "new line\n")

fs.mkdir_p(path: String) -> Result[Unit, String]

Create a directory and all parent directories

fs.mkdir_p("data/cache/images")

fs.exists(path: String) -> Bool

Check if a file or directory exists

if fs.exists("config.toml") then ...

fs.read_lines(path: String) -> Result[List[String], String]

Read a file as a list of lines

let lines = fs.read_lines("data.csv")

fs.remove(path: String) -> Result[Unit, String]

Delete a file

fs.remove("temp.txt")

fs.list_dir(path: String) -> Result[List[String], String]

List entries in a directory

let entries = fs.list_dir("src/")

fs.is_dir(path: String) -> Bool

Check if a path is a directory

if fs.is_dir("src") then ...

fs.is_file(path: String) -> Bool

Check if a path is a regular file

if fs.is_file("readme.md") then ...

fs.copy(src: String, dst: String) -> Result[Unit, String]

Copy a file from src to dst

fs.copy("a.txt", "b.txt")

fs.rename(src: String, dst: String) -> Result[Unit, String]

Rename or move a file

fs.rename("old.txt", "new.txt")

fs.walk(dir: String) -> Result[List[String], String]

Recursively list all files in a directory tree

let all_files = fs.walk("src/")

fs.remove_all(path: String) -> Result[Unit, String]

Recursively delete a directory and all its contents

fs.remove_all("build/")

fs.file_size(path: String) -> Result[Int, String]

Get file size in bytes

let size = fs.file_size("data.bin")

fs.temp_dir() -> String

Get the system temporary directory path

let tmp = fs.temp_dir()

fs.stat(path: String) -> Result[{size: Int, is_dir: Bool, is_file: Bool, modified: Int}, String]

Get file metadata: size, type, and modification time

let info = fs.stat("file.txt") // {size, is_dir, is_file, modified}

fs.glob(pattern: String) -> Result[List[String], String]

Find files matching a glob pattern

let files = fs.glob("src/**/*.almd")

fs.create_temp_file(prefix: String) -> Result[String, String]

Create a temporary file with a given prefix, return its path

let path = fs.create_temp_file("almide-")

fs.create_temp_dir(prefix: String) -> Result[String, String]

Create a temporary directory with a given prefix, return its path

let dir = fs.create_temp_dir("build-")

fs.is_symlink(path: String) -> Bool

Check if a path is a symbolic link

if fs.is_symlink("link") then ...

fs.modified_at(path: String) -> Result[Int, String]

Get file modification time as Unix timestamp (seconds)

let ts = fs.modified_at("file.txt")