FileSystem
Let's you manipulate the file system.
Initialization
This value represents the permission to perform file system operations.
Only code you trust should have access to this value.
Initialize the FileSystem
subsystem, which gains you the permission to perform
file system operations.
Errors
The set of errors that can happen when accessing a file or directory.
An error thrown by the OS, in situations where we don't expect errors to happen, or have been unable to reproduce such an error in development.
File open/close
A file handle is used to perform operations on a file, like reading and writing.
Having a file handle gives you access to perform certain operations, so make sure you only pass a file handle to code you can trust.
The FileHandle
type also contains the read and write access permissions as part of it's
type.
A FileHandle
that can be used in read operations.
A FileHandle
that can be used in write operations.
A FileHandle
that can be used for both read and write operations.
Open the file at the provided path with read permissions.
There are several ways to open a file for writing.
EnsureEmpty
will create an empty file if it doesn't exist, or remove all contents of a file if it does exist.ExpectExisting
will fail the task if it doesn't exist.ExpectNotExisting
will fail the task if the file does exist.
Open a file at the provided path with write permissions.
Open a file for at the provided path with both read and write permissions.
Close a file. All operations performed against the given FileHandle
will fail.
Read from file
Read all bytes in a file.
Read length
number of bytes from a file, starting at offset
bytes.
Write to file
Write the provided bytes into the file. If the file is not empty, bytes will be overwritten.
Write bytes into a specific location of a file.
Remove files and directories
This record allows you to customize the behaviour of remove
.
recursive
will delete everything inside a directory.ignoreErrors
will... ignore any errors related to a remove operation.
Remove the file or directory at the given path.
Directories
Create a new directory at the given path.
If recursive
is True
, then a directory will be created for every section of the
given path.
Represents entries in a directory.
Variants for each type of entry, with a String
representing the relative path.
As returned by FileSystem.listDirectory
.
Returns an Array
of DirEntry
variants holding names of the files in the
directory at the given path.
Joins an array of strings using the filesystem's path seperator, then normalizes the result. An empty array will result in ".", a path to the current working directory.
buildPath [] == "."
buildPath [ "one", "two", "three" ] == "one/two/three" -- On Unix based operating systems
Removes redundant symbols from the path.
normalizePath "one/two/.." == "one/two"
Returns the current working directory of the program. This is the directory that all relative paths are relative to.