fs2-io/fs2.io.file/Files

Files

trait Files[F <: ([_$1] =>> Any)]
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.
Companion
object
class Object
trait Matchable
class Any

Value members

Methods

def copy(source: Path, target: Path, flags: Seq[CopyOption]): F[Path]
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.
def createDirectory(path: Path, flags: Seq[FileAttribute[]]): F[Path]
Creates a new directory at the given path.
def createDirectories(path: Path, flags: Seq[FileAttribute[]]): F[Path]
Creates a new directory at the given path and creates all nonexistent parent directories beforehand.
def delete(path: Path): F[Unit]
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.
def deleteIfExists(path: Path): F[Boolean]
Like delete, but will not fail when the path doesn't exist.
def deleteDirectoryRecursively(path: Path, options: Set[FileVisitOption]): F[Unit]
Recursively delete a directory
def directoryStream(path: Path): Stream[F, Path]
Creates a stream of Paths inside a directory.
def directoryStream(path: Path, filter: Path => Boolean): Stream[F, Path]
Creates a stream of Paths inside a directory, filtering the results by the given predicate.
def directoryStream(path: Path, glob: String): Stream[F, Path]
Creates a stream of Paths inside a directory which match the given glob.
def exists(path: Path, flags: Seq[LinkOption]): F[Boolean]
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.
def isDirectory(path: Path, linkOption: Seq[LinkOption]): F[Boolean]
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.
Value Params
options
  • options indicating how symbolic links are handled
path
the path to the file to test
Returns
true if the file is a directory; false if the file does not exist, is not a directory, or it cannot be determined if the file is a directory or not.
def isFile(path: Path, linkOption: Seq[LinkOption]): F[Boolean]
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.
Value Params
options
options indicating how symbolic links are handled
path
the path to the file
Returns
true if the file is a regular file; false if the file does not exist, is not a regular file, or it cannot be determined if the file is a regular file or not.
def move(source: Path, target: Path, flags: Seq[CopyOption]): F[Path]
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.
def open(path: Path, flags: Seq[OpenOption]): Resource[F, FileHandle[F]]
Creates a FileHandle for the file at the supplied Path.
def openFileChannel(channel: F[FileChannel]): Resource[F, FileHandle[F]]
Creates a FileHandle for the supplied FileChannel.
def permissions(path: Path, flags: Seq[LinkOption]): F[Set[PosixFilePermission]]
Get file permissions as set of PosixFilePermission.
Note: this will only work for POSIX supporting file systems.
def readAll(path: Path, chunkSize: Int): Stream[F, Byte]
Reads all data from the file at the specified java.nio.file.Path.
def readCursor(path: Path, flags: Seq[OpenOption]): Resource[F, ReadCursor[F]]
Returns a ReadCursor for the specified path. The READ option is added to the supplied flags.
def readRange(path: Path, chunkSize: Int, start: Long, end: Long): Stream[F, Byte]
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.
def setPermissions(path: Path, permissions: Set[PosixFilePermission]): F[Path]
Set file permissions from set of PosixFilePermission.
Note: this will only work for POSIX supporting file systems.
def size(path: Path): F[Long]
Returns the size of a file (in bytes).
def tail(path: Path, chunkSize: Int, offset: Long, pollDelay: FiniteDuration): Stream[F, Byte]
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.
def tempFile(dir: Option[Path], prefix: String, suffix: String, attributes: Seq[FileAttribute[]]): Resource[F, Path]
Creates a Resource which can be used to create a temporary file.
The file is created during resource allocation, and removed during its release.
Value Params
attributes
an optional list of file attributes to set atomically when creating the file
dir
the directory which the temporary file will be created in. Pass in None to use the default system temp directory
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
def tempDirectory(dir: Option[Path], prefix: String, attributes: Seq[FileAttribute[]]): Resource[F, Path]
Creates a Resource which can be used to create a temporary directory.
The directory is created during resource allocation, and removed during its release.
Value Params
attributes
an optional list of file attributes to set atomically when creating the directory
dir
the directory which the temporary directory will be created in. Pass in None to use the default system temp directory
prefix
the prefix string to be used in generating the directory's name
Returns
a resource containing the path of the temporary directory
def walk(start: Path): Stream[F, Path]
Creates a stream of Paths contained in a given file tree. Depth is unlimited.
def walk(start: Path, options: Seq[FileVisitOption]): Stream[F, Path]
Creates a stream of Paths contained in a given file tree, respecting the supplied options. Depth is unlimited.
def walk(start: Path, maxDepth: Int, options: Seq[FileVisitOption]): Stream[F, Path]
Creates a stream of Paths contained in a given file tree down to a given depth.
def watcher: Resource[F, Watcher[F]]
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().
def watch(path: Path, types: Seq[EventType], modifiers: Seq[Modifier], pollTimeout: FiniteDuration): Stream[F, Event]
Watches a single path.
Alias for creating a watcher and watching the supplied path, releasing the watcher when the resulting stream is finalized.
def writeAll(path: Path, flags: Seq[StandardOpenOption]): (F, Byte) => INothing
Writes all data to the file at the specified java.nio.file.Path.
Adds the WRITE flag to any other OpenOption flags specified. By default, also adds the CREATE flag.
def writeCursor(path: Path, flags: Seq[OpenOption]): Resource[F, WriteCursor[F]]
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.
def writeCursorFromFileHandle(file: FileHandle[F], append: Boolean): F[WriteCursor[F]]
Returns a WriteCursor for the specified file handle.
If append is true, the offset is initialized to the current size of the file.
def writeRotate(computePath: F[Path], limit: Long, flags: Seq[StandardOpenOption]): (F, Byte) => INothing
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.