fs2-io/fs2.io.file/PosixFiles

PosixFiles

sealed trait PosixFiles[F[_]] extends UnsealedReadFiles[F]

Enables interacting with the file system in a way modeled on Node.js fs module which in turn is modeled on standard POSIX functions.

See also
Companion
object
trait UnsealedReadFiles[F]
trait ReadFiles[F]
class Object
trait Matchable
class Any

Value members

Abstract methods

def access(path: Path, mode: AccessMode): F[Boolean]
def chmod(path: Path, mode: FileAccessMode): F[Unit]
def chown(path: Path, uid: Long, guid: Long): F[Unit]
def copyFile(src: Path, dest: Path, mode: CopyMode): F[Unit]
def lchown(path: Path, uid: Long, guid: Long): F[Unit]
def lstat(path: Path): F[Stats]
def mkdir(path: Path, recursive: Boolean, mode: FileAccessMode): F[Path]
def mkdtemp(path: Path, prefix: String): Resource[F, Path]
def open(path: Path, flags: Flags, mode: FileAccessMode): Resource[F, FileHandle[F]]
def opendir(path: Path): Stream[F, Path]
def readAll(path: Path, flags: Flags): Stream[F, Byte]
def readCursor(path: Path, flags: Flags): Resource[F, ReadCursor[F]]
def realpath(path: Path): F[Path]
def rename(oldPath: Path, newPath: Path): F[Unit]
def rm(path: Path, force: Boolean, maxRetries: Int, recursive: Boolean, retryDelay: FiniteDuration): F[Unit]
def rmdir(path: Path, maxRetries: Int, retryDelay: FiniteDuration): F[Unit]
def stat(path: Path): F[Stats]
def walk(path: Path, maxDepth: Int): Stream[F, Path]
def writeAll(path: Path, flags: Flags, mode: FileAccessMode): (F, Byte) => INothing
def writeCursor(path: Path, flags: Flags, mode: FileAccessMode): Resource[F, WriteCursor[F]]
def writeCursorFromFileHandle(file: FileHandle[F], append: Boolean): F[WriteCursor[F]]
def writeRotate(computePath: F[Path], limit: Long, flags: Flags, mode: FileAccessMode): (F, Byte) => INothing

Inherited methods

def readAll(path: Path, chunkSize: Int): Stream[F, Byte]

Reads all data from the file at the specified path.

Reads all data from the file at the specified path.

Inherited from
ReadFiles
def readCursor(path: Path): Resource[F, ReadCursor[F]]

Returns a ReadCursor for the specified path.

Returns a ReadCursor for the specified path.

Inherited from
ReadFiles
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 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.

Inherited from
ReadFiles
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.

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.

Inherited from
ReadFiles