Files

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 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 hard link with an existing file.

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 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.

User's current working directory

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 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.

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 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.

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 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 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 path is a symbolic link.

Returns true if the supplied path exists and is writable.

Returns the line separator for the specific OS

Gets the contents of the specified directory.

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).

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 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.

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.

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.

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 file and deletes it upon finalization of the returned resource.

User's home directory

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.

Returns a WriteCursor for the specified path.

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.

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.

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. 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 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.

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.

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 POSIX attributes for the supplied path. Symbolic links are not 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 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)).

Reads all bytes from the file specified.

Returns a ReadCursor for the specified path, using the supplied flags when opening the file.

Reads all bytes from the file specified and decodes them as a utf8 string.

Reads all bytes from the file specified and decodes them as utf8 lines.

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 stream of paths contained in a given file tree. Depth is unlimited.

Writes all data to the file at the specified path.

The file is created if it does not exist and is truncated. Use writeAll(path, Flags.Append) to append to the end of the file, or pass other flags to further customize behavior.

Writes to the specified file as an utf8 string.

The file is created if it does not exist and is truncated. Use writeUtf8(path, Flags.Append) to append to the end of the file, or pass other flags to further customize behavior.

Writes to the specified file as an utf8 string using the specified flags to open the file.

Writes each string to the specified file as utf8 lines.

The file is created if it does not exist and is truncated. Use writeUtf8Lines(path, Flags.Append) to append to the end of the file, or pass other flags to further customize behavior.

Writes each string to the specified file as utf8 lines using the specified flags to open the file.

Gets the contents of the specified directory whose paths match the supplied glob pattern.

Example glob patterns: *.scala, *.{scala,java}

JVM only.

Creates a FileHandle for the supplied NIO FileChannel. JVM only.

Watches a single path.

Alias for creating a watcher and watching the supplied path, releasing the watcher when the resulting stream is finalized.

JVM only.

Watches a single path.

Alias for creating a watcher and watching the supplied path, releasing the watcher when the resulting stream is finalized.

JVM only.

Copies a file from the source to the target path,

By default, the copy fails if the target file already exists or is a symbolic link.

Creates a new directory at the given path and creates all nonexistent parent directories beforehand.

Creates a new directory at the given path.

Deletes a file.

If the file is a directory then the directory must be empty for this action to succeed. This action will fail if the path doesn't exist.

Recursively delete a directory

Like delete, but will not fail when the path doesn't exist.

Creates a stream of Paths inside a directory which match the given glob.

Creates a stream of Paths inside a directory, filtering the results by the given predicate.

Creates a stream of Paths inside a directory.

Checks if a file exists.

Note that the result of this method is immediately outdated. If this method indicates the file exists then there is no guarantee that a subsequence access will succeed. Care should be taken when using this method in security sensitive applications.

Tests whether a file is a directory.

The options sequence may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.

Where is it required to distinguish an I/O exception from the case that the file is not a directory then the file attributes can be read with the readAttributes method and the file type tested with the BasicFileAttributes.isDirectory() method.

Tests whether a file is a regular file with opaque content.

The options sequence may be used to indicate how symbolic links are handled for the case that the file is a symbolic link. By default, symbolic links are followed and the file attribute of the final target of the link is read. If the option NOFOLLOW_LINKS is present then symbolic links are not followed.

Where is it required to distinguish an I/O exception from the case that the file is not a regular file then the file attributes can be read with the readAttributes method and the file type tested with the BasicFileAttributes.isRegularFile() method.

Moves (or renames) a file from the source to the target path.

By default, the move fails if the target file already exists or is a symbolic link.

Creates a FileHandle for the file at the supplied Path.

Get file permissions as set of PosixFilePermission.

Note: this will only work for POSIX supporting file systems.

Reads all data from the file at the specified java.nio.file.Path.

Returns a ReadCursor for the specified path. The READ option is added to the supplied flags.

Returns a ReadCursor for the specified path.

Reads a range of data synchronously from the file at the specified java.nio.file.Path. start is inclusive, end is exclusive, so when start is 0 and end is 2, two bytes are read.

Set file permissions from set of PosixFilePermission.

Note: this will only work for POSIX supporting file systems.

Returns the size of a file (in bytes).

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 Resource which can be used to create a temporary directory. The directory is created during resource allocation, and removed during its release.

Creates a Resource which can be used to create a temporary file. The file is created during resource allocation, and removed during its release.

Creates a stream of JPaths contained in a given file tree down to a given depth.

Creates a stream of JPaths contained in a given file tree, respecting the supplied options. Depth is unlimited.

Creates a stream of JPaths contained in a given file tree. Depth is unlimited.

Watches a single path.

Alias for creating a watcher and watching the supplied path, releasing the watcher when the resulting stream is finalized.

Creates a Watcher for the default file system.

The watcher is returned as a resource. To use the watcher, lift the resource to a stream, watch or register 1 or more paths, and then return watcher.events().

Writes all data to the file at the specified java.nio.file.JPath.

Adds the WRITE flag to any other OpenOption flags specified. By default, also adds the CREATE flag.

Returns a WriteCursor for the specified path.

The WRITE option is added to the supplied flags. If the APPEND option is present in flags, 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.

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.