Search results

There are no results.

std.fs.file

Types and methods for manipulating files on a filesystem.

Rather than using a single "File" type for all different file modes, Inko uses three separate file types:

  • ReadOnlyFile: read-only file operations
  • WriteOnlyFile: write-only file operations
  • ReadWriteFile: read-write file operations

Using different types per file mode allows for a type-safe file API.

Files are automatically closed when they are dropped. Any errors that may occur when closing a file are ignored.

The WriteOnlyFile and ReadWriteFile don't explicitly flush any writes upon being dropped, as any errors produced by this call would be ignored. It's highly recommended to call WriteOnlyFile.flush / ReadWriteFile.flush before dropping a file if you need to guarantee any pending writes are flushed to the underlying storage medium.

Classes

ReadOnlyFile

A file that can only be used for reads.

ReadWriteFile

A file that can be used for both reads and writes.

WriteOnlyFile

A file that can only be used for writes.