Packages

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

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.

Source
ReadCursor.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadCursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ReadCursor(file: FileHandle[F], offset: Long)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. val file: FileHandle[F]
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  10. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  11. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. val offset: Long
  14. 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.

  15. def readAll(chunkSize: Int): Pull[F, Byte, ReadCursor[F]]

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

  16. 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]])].

  17. def readUntil(chunkSize: Int, end: Long): Pull[F, Byte, ReadCursor[F]]

    Reads chunks until the specified end position in the file.

    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.

  18. def seek(position: Long): ReadCursor[F]

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

  19. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  20. def tail(chunkSize: Int, pollDelay: FiniteDuration)(implicit t: Temporal[F]): Pull[F, Byte, ReadCursor[F]]

    Returns an infinite stream that reads until the end of the file and then starts polling the file for additional writes.

    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.

    pollDelay

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

  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped