This documentation is also published as Markdown for efficient machine reading: the whole site is indexed at /llms.txt, and every page has a clean Markdown copy at the same URL with .md appended. These are generated from the same source and cost far fewer tokens to read than this rendered HTML.

Standard Library

std.io

Types

Type	Description
`Directory`	A path to a directory.
`File`	A path to a file.
`Files`	Files matched by glob patterns.

Functions

Function	Description
`compress(source: Directory, archive: File) -> Result<(), string>`	Compresses the directory into a zip archive, replacing any existing archive.
`directory(path: string) -> Directory`	Creates a `Directory` for the path, without touching the disk.
`exists(path: string) -> bool`	Whether a file or directory exists at the path.
`file(path: string) -> File`	Creates a `File` for the path, without touching the disk.
`glob(patterns: ...string) -> Files`	Finds the files that match the patterns, sorted by path. A pattern starting with `!` excludes what the patterns before it matched.
`read_text(source: File) -> Result<string, string>`	Reads the file as UTF-8 text.
`write_text(target: File, text: string) -> Result<(), string>`	Writes the text to the file as UTF-8, replacing what was there. The directory must already exist.

`Directory`

Field	Description
`path: string`	The path to the directory.

`File`

Field	Description
`path: string`	The path to the file.
`name: string`	The file name, with its extension.
`stem: string`	The file name, without its extension.

`Files`

Implements Enumerable<File>.

Field	Description
`files: File[]`	The matched files, sorted by path.
`patterns: string[]`	The patterns the files were matched with.

On this page