ReadCursor

fs2.io.file.ReadCursor
See theReadCursor companion object
final case class ReadCursor[F[_]](file: FileHandle[F], offset: Long)

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.

Attributes

Companion:
object
Source:
ReadCursor.scala
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

def read(chunkSize: Int)(implicit F: Functor[F]): F[Option[(ReadCursor[F], Chunk[Byte])]]

Reads a single chunk from the underlying file handle, returning the read chunk and a new cursor with an offset incremented by the chunk size.

Reads a single chunk from the underlying file handle, returning the read chunk and a new cursor with an offset incremented by the chunk size.

Attributes

Source:
ReadCursor.scala

Reads all chunks from the underlying file handle, returning a cursor with offset incremented by the total number of bytes read.

Reads all chunks from the underlying file handle, returning a cursor with offset incremented by the total number of bytes read.

Attributes

Source:
ReadCursor.scala
def readPull(chunkSize: Int): Pull[F, Nothing, Option[(ReadCursor[F], Chunk[Byte])]]

Like read but returns a pull instead of an F[(ReadCursor[F], Option[Chunk[Byte]])].

Like read but returns a pull instead of an F[(ReadCursor[F], Option[Chunk[Byte]])].

Attributes

Source:
ReadCursor.scala

Reads chunks until the specified end position in the file. Returns a pull that outputs the read chunks and completes with a cursor with offset incremented by the total number of bytes read.

Reads chunks until the specified end position in the file. Returns a pull that outputs the read chunks and completes with a cursor with offset incremented by the total number of bytes read.

Attributes

Source:
ReadCursor.scala

Returns a new cursor with the offset adjusted to the specified position.

Returns a new cursor with the offset adjusted to the specified position.

Attributes

Source:
ReadCursor.scala

Returns an infinite stream that reads until the end of the file and then starts polling the file for additional writes. Similar to the tail command line utility.

Returns an infinite stream that reads until the end of the file and then starts polling the file for additional writes. Similar to the tail command line utility.

Attributes

pollDelay

amount of time to wait upon reaching the end of the file before polling for updates

Source:
ReadCursor.scala

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product