Packages

  • package root
    Definition Classes
    root
  • package fs2
    Definition Classes
    root
  • package io

    Provides various ways to work with streams that perform IO.

    Provides various ways to work with streams that perform IO.

    Definition Classes
    fs2
  • package file
    Definition Classes
    io
  • FileHandle
  • Path
  • PosixFiles
  • ReadCursor
  • ReadFiles
  • WriteCursor
  • package net

    Provides support for doing network I/O -- TCP, UDP, and TLS.

    Provides support for doing network I/O -- TCP, UDP, and TLS.

    Definition Classes
    io
p

fs2.io

file

package file

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. Protected

Type Members

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

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

  2. final class Path extends AnyVal
  3. 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

    https://nodejs.org/api/fs.html

  4. final case class ReadCursor[F[_]](file: FileHandle[F], offset: Long) extends Product with Serializable

    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.

  5. sealed trait ReadFiles[F[_]] extends AnyRef

    Platform-agnostic methods for reading files.

  6. final case class WriteCursor[F[_]](file: FileHandle[F], offset: Long) extends Product with Serializable

    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.

Value Members

  1. object FileHandle extends FileHandleCompanionPlatform
  2. object Path
  3. object PosixFiles
  4. object ReadCursor extends ReadCursorCompanionPlatform with Serializable
  5. object ReadFiles extends ReadFilesCompanionPlatform
  6. object WriteCursor extends WriteCursorCompanionPlatform with Serializable

Ungrouped