Provides operations related to working with files in the effect F
.
An instance is available for any effect F
which has an Async[F]
instance.
The operations on this trait are implemented for both the JVM and Node.js.
Some operations only work on POSIX file systems, though such methods generally
have "Posix" in their names (e.g. getPosixPermissions
). A small number of methods
are only available on the JVM (e.g. variant of list
which takes a glob pattern) and
are indicated as such in their ScalaDoc.
- Companion
- object
Value members
Abstract methods
Copies the source to the target, following any directives supplied in the flags.
By default, an error occurs if the target already exists, though this can be overriden via CopyFlag.ReplaceExisting
.
Copies the source to the target, following any directives supplied in the flags.
By default, an error occurs if the target already exists, though this can be overriden via CopyFlag.ReplaceExisting
.
Creates the specified directory and any parent directories, using the supplied permissions for any directories
that get created as a result of this operation. For example if /a
exists and
createDirectories(Path("/a/b/c"), Some(p))
is called, /a/b
and /a/b/c
are created with permissions set
to p
on each (and the permissions of /a
remain unmodified).
Creates the specified directory and any parent directories, using the supplied permissions for any directories
that get created as a result of this operation. For example if /a
exists and
createDirectories(Path("/a/b/c"), Some(p))
is called, /a/b
and /a/b/c
are created with permissions set
to p
on each (and the permissions of /a
remain unmodified).
Creates the specified directory with the specified permissions. Fails if the parent path does not already exist.
Creates the specified directory with the specified permissions. Fails if the parent path does not already exist.
Creates the specified file with the specified permissions. Fails if the parent path does not already exist.
Creates the specified file with the specified permissions. Fails if the parent path does not already exist.
Creates a symbolic link which points to the supplied target. If defined, the supplied permissions are set on the created link.
Creates a symbolic link which points to the supplied target. If defined, the supplied permissions are set on the created link.
Creates a temporary directory.
The created directory is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempDirectory
to get a resource which deletes upon resource finalization.
Creates a temporary directory.
The created directory is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempDirectory
to get a resource which deletes upon resource finalization.
- Value Params
- dir
the directory which the temporary directory will be created in. Pass none to use the default system temp directory
- permissions
permissions to set on the created directory
- prefix
the prefix string to be used in generating the directory's name
Creates a temporary file.
The created file is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempFile
to get a resource which deletes upon resource finalization.
Creates a temporary file.
The created file is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempFile
to get a resource which deletes upon resource finalization.
- Value Params
- dir
the directory which the temporary file will be created in. Pass none to use the default system temp directory
- permissions
permissions to set on the created file
- prefix
the prefix string to be used in generating the file's name
- suffix
the suffix string to be used in generating the file's name
Deletes the specified file or empty directory, failing if it does not exist.
Deletes the specified file or empty directory, failing if it does not exist.
Deletes the specified file or empty directory, passing if it does not exist.
Deletes the specified file or empty directory, passing if it does not exist.
Deletes the specified file or directory.
If the path is a directory and is non-empty, its contents are recursively deleted.
Symbolic links are followed when followLinks
is true.
Deletes the specified file or directory.
If the path is a directory and is non-empty, its contents are recursively deleted.
Symbolic links are followed when followLinks
is true.
Returns true if the specified path exists.
Symbolic links are followed when followLinks
is true.
For example, if the symbolic link foo
points to bar
and bar
does not exist,
exists(Path("foo"), true)
returns false
but exists(Path("foo"), false)
returns true
.
Returns true if the specified path exists.
Symbolic links are followed when followLinks
is true.
For example, if the symbolic link foo
points to bar
and bar
does not exist,
exists(Path("foo"), true)
returns false
but exists(Path("foo"), false)
returns true
.
Gets BasicFileAttributes
for the supplied path. Symbolic links are not followed when followLinks
is true.
Gets BasicFileAttributes
for the supplied path. Symbolic links are not followed when followLinks
is true.
Gets the last modified time of the supplied path.
The last modified time is represented as a duration since the Unix epoch.
Symbolic links are followed when followLinks
is true.
Gets the last modified time of the supplied path.
The last modified time is represented as a duration since the Unix epoch.
Symbolic links are followed when followLinks
is true.
Gets the POSIX attributes for the supplied path.
Symbolic links are followed when followLinks
is true.
Gets the POSIX attributes for the supplied path.
Symbolic links are followed when followLinks
is true.
Gets the POSIX permissions of the supplied path.
Symbolic links are followed when followLinks
is true.
Gets the POSIX permissions of the supplied path.
Symbolic links are followed when followLinks
is true.
Returns true if the supplied path exists and is a directory. Symbolic links are followed when followLinks
is true.
Returns true if the supplied path exists and is a directory. Symbolic links are followed when followLinks
is true.
Returns true if the supplied path exists and is executable.
Returns true if the supplied path exists and is executable.
Returns true if the supplied path is a hidden file (note: may not check for existence).
Returns true if the supplied path is a hidden file (note: may not check for existence).
Returns true if the supplied path exists and is readable.
Returns true if the supplied path exists and is readable.
Returns true if the supplied path is a regular file. Symbolic links are followed when followLinks
is true.
Returns true if the supplied path is a regular file. Symbolic links are followed when followLinks
is true.
Returns true if the supplied paths reference the same file.
Returns true if the supplied paths reference the same file.
Returns true if the supplied path is a symbolic link.
Returns true if the supplied path is a symbolic link.
Returns true if the supplied path exists and is writable.
Returns true if the supplied path exists and is writable.
Moves the source to the target, following any directives supplied in the flags.
By default, an error occurs if the target already exists, though this can be overriden via CopyFlag.ReplaceExisting
.
Moves the source to the target, following any directives supplied in the flags.
By default, an error occurs if the target already exists, though this can be overriden via CopyFlag.ReplaceExisting
.
Creates a FileHandle
for the file at the supplied Path
.
The supplied flags indicate the mode used when opening the file (e.g. read, write, append)
as well as the ability to specify additional options (e.g. automatic deletion at process exit).
Creates a FileHandle
for the file at the supplied Path
.
The supplied flags indicate the mode used when opening the file (e.g. read, write, append)
as well as the ability to specify additional options (e.g. automatic deletion at process exit).
Reads all bytes from the file specified, reading in chunks up to the specified limit, and using the supplied flags to open the file.
Reads all bytes from the file specified, reading in chunks up to the specified limit, and using the supplied flags to open the file.
Returns a ReadCursor
for the specified path, using the supplied flags when opening the file.
Returns a ReadCursor
for the specified path, using the supplied flags when opening the file.
Reads a range of data synchronously from the file at the specified path.
start
is inclusive, end
is exclusive, so when start
is 0 and end
is 2,
two bytes are read.
Reads a range of data synchronously from the file at the specified path.
start
is inclusive, end
is exclusive, so when start
is 0 and end
is 2,
two bytes are read.
Returns the real path i.e. the actual location of path
.
The precise definition of this method is implementation dependent but in general
it derives from this path, an absolute path that locates the same file as this path,
but with name elements that represent the actual name of the directories and the file.
Returns the real path i.e. the actual location of path
.
The precise definition of this method is implementation dependent but in general
it derives from this path, an absolute path that locates the same file as this path,
but with name elements that represent the actual name of the directories and the file.
Sets the last modified, last access, and creation time fields of the specified path.
Sets the last modified, last access, and creation time fields of the specified path.
Times which are supplied as None
are not modified. E.g., setTimes(p, Some(t), Some(t), None, false)
sets the last modified and last access time to t
and does not change the creation time.
If the path is a symbolic link and followLinks
is true, the target of the link as
times set. Otherwise, the link itself has times set.
Sets the POSIX permissions for the supplied path. Fails on non-POSIX file systems.
Sets the POSIX permissions for the supplied path. Fails on non-POSIX file systems.
Gets the size of the supplied path, failing if it does not exist.
Gets the size of the supplied path, failing if it does not exist.
Returns an infinite stream of data from the file at the specified path.
Starts reading from the specified offset and upon reaching the end of the file,
polls every pollDuration
for additional updates to the file.
Returns an infinite stream of data from the file at the specified path.
Starts reading from the specified offset and upon reaching the end of the file,
polls every pollDuration
for additional updates to the file.
Read operations are limited to emitting chunks of the specified chunk size but smaller chunks may occur.
If an error occurs while reading from the file, the overall stream fails.
Creates a temporary directory and deletes it upon finalization of the returned resource.
Creates a temporary directory and deletes it upon finalization of the returned resource.
- Value Params
- dir
the directory which the temporary directory will be created in. Pass in None to use the default system temp directory
- permissions
permissions to set on the created file
- prefix
the prefix string to be used in generating the directory's name
- Returns
a resource containing the path of the temporary directory
Creates a temporary file and deletes it upon finalization of the returned resource.
Creates a temporary file and deletes it upon finalization of the returned resource.
- Value Params
- dir
the directory which the temporary file will be created in. Pass in None to use the default system temp directory
- permissions
permissions to set on the created file
- prefix
the prefix string to be used in generating the file's name
- suffix
the suffix string to be used in generating the file's name
- Returns
a resource containing the path of the temporary file
Creates a stream of paths contained in a given file tree down to a given depth.
Creates a stream of paths contained in a given file tree down to a given depth.
Writes all data to the file at the specified path, using the specified flags to open the file.
Writes all data to the file at the specified path, using the specified flags to open the file.
Returns a WriteCursor
for the specified file handle.
Returns a WriteCursor
for the specified file handle.
If append
is true, the offset is initialized to the current size of the file.
Writes all data to a sequence of files, each limited in size to limit
.
Writes all data to a sequence of files, each limited in size to limit
.
The computePath
operation is used to compute the path of the first file
and every subsequent file. Typically, the next file should be determined
by analyzing the current state of the filesystem -- e.g., by looking at all
files in a directory and generating a unique name.
Concrete methods
Copies the source to the target, failing if source does not exist or the target already exists.
To replace the existing instead, use copy(source, target, CopyFlags(CopyFlag.ReplaceExisting))
.
Copies the source to the target, failing if source does not exist or the target already exists.
To replace the existing instead, use copy(source, target, CopyFlags(CopyFlag.ReplaceExisting))
.
Creates the specified directory and any non-existant parent directories.
Creates the specified directory and any non-existant parent directories.
Creates the specified directory. Fails if the parent path does not already exist.
Creates the specified directory. Fails if the parent path does not already exist.
Creates the specified file. Fails if the parent path does not already exist.
Creates the specified file. Fails if the parent path does not already exist.
Creates a symbolic link which points to the supplied target.
Creates a symbolic link which points to the supplied target.
Creates a temporary directory.
The created directory is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempDirectory
to get a resource which deletes upon resource finalization.
Creates a temporary directory.
The created directory is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempDirectory
to get a resource which deletes upon resource finalization.
Creates a temporary file.
The created file is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempFile
to get a resource, which is deleted upon resource finalization.
Creates a temporary file.
The created file is not automatically deleted - it is up to the operating system to decide when the file is deleted.
Alternatively, use tempFile
to get a resource, which is deleted upon resource finalization.
Deletes the specified file or directory. If the path is a directory and is non-empty, its contents are recursively deleted. Symbolic links are not followed (but are deleted).
Deletes the specified file or directory. If the path is a directory and is non-empty, its contents are recursively deleted. Symbolic links are not followed (but are deleted).
Returns true if the specified path exists. Symbolic links are followed -- see the overload for more details on links.
Returns true if the specified path exists. Symbolic links are followed -- see the overload for more details on links.
Gets BasicFileAttributes
for the supplied path. Symbolic links are not followed.
Gets BasicFileAttributes
for the supplied path. Symbolic links are not followed.
Gets the last modified time of the supplied path. The last modified time is represented as a duration since the Unix epoch. Symbolic links are followed.
Gets the last modified time of the supplied path. The last modified time is represented as a duration since the Unix epoch. Symbolic links are followed.
Gets the POSIX attributes for the supplied path. Symbolic links are not followed.
Gets the POSIX attributes for the supplied path. Symbolic links are not followed.
Gets the POSIX permissions of the supplied path. Symbolic links are followed.
Gets the POSIX permissions of the supplied path. Symbolic links are followed.
Returns true if the supplied path exists and is a directory. Symbolic links are followed.
Returns true if the supplied path exists and is a directory. Symbolic links are followed.
Returns true if the supplied path is a regular file. Symbolic links are followed.
Returns true if the supplied path is a regular file. Symbolic links are followed.
Moves the source to the target, failing if source does not exist or the target already exists.
To replace the existing instead, use move(source, target, CopyFlags(CopyFlag.ReplaceExisting))
.
Moves the source to the target, failing if source does not exist or the target already exists.
To replace the existing instead, use move(source, target, CopyFlags(CopyFlag.ReplaceExisting))
.
Creates a temporary directory and deletes it upon finalization of the returned resource.
Creates a temporary directory and deletes it upon finalization of the returned resource.
Creates a temporary file and deletes it upon finalization of the returned resource.
Creates a temporary file and deletes it upon finalization of the returned resource.
Creates a stream of paths contained in a given file tree. Depth is unlimited.
Creates a stream of paths contained in a given file tree. Depth is unlimited.