fs2.io.file

package fs2.io.file

Type members

Classlikes

trait FileHandle[F[_]] extends FileHandlePlatform[F]

Provides the ability to read/write/lock/inspect a file in the effect F.

Provides the ability to read/write/lock/inspect a file in the effect F.

Companion
object
object FileHandle extends FileHandleCompanionPlatform
Companion
class
final class Path(path: String) extends AnyVal
Companion
object
object Path
Companion
class
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.

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
object PosixFiles
Companion
class
final case class ReadCursor[F[_]](file: FileHandle[F], offset: Long)

Associates a FileHandle with an offset in to the file.

Associates a FileHandle with an offset in to the file.

This encapsulates the pattern of incrementally reading bytes in from a file, a chunk at a time. Convenience methods are provided for working with pulls.

Companion
object
object ReadCursor extends ReadCursorCompanionPlatform
Companion
class
sealed trait ReadFiles[F[_]]

Platform-agnostic methods for reading files.

Platform-agnostic methods for reading files.

Companion
object
object ReadFiles extends ReadFilesCompanionPlatform
Companion
class
final case class WriteCursor[F[_]](file: FileHandle[F], offset: Long)

Associates a FileHandle with an offset in to the file.

Associates a FileHandle with an offset in to the file.

This encapsulates the pattern of incrementally writing bytes in to a file, a chunk at a time. Convenience methods are provided for working with pulls.

Companion
object
object WriteCursor extends WriteCursorCompanionPlatform
Companion
class