final case class WriteCursor[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 writing bytes in to a file, a chunk at a time. Convenience methods are provided for working with pulls.
- Source
- WriteCursor.scala
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- WriteCursor
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new WriteCursor(file: FileHandle[F], offset: Long)
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val file: FileHandle[F]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- val offset: Long
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def seek(position: Long): WriteCursor[F]
Returns a new cursor with the offset adjusted to the specified position.
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def write(bytes: Chunk[Byte])(implicit F: Monad[F]): F[WriteCursor[F]]
Writes a single chunk to the underlying file handle, returning a new cursor with an offset incremented by the chunk size.
- def writeAll(s: Stream[F, Byte]): Pull[F, Nothing, WriteCursor[F]]
Writes all chunks from the supplied stream to the underlying file handle, returning a cursor with offset incremented by the total number of bytes written.
- def writePull(bytes: Chunk[Byte]): Pull[F, Nothing, WriteCursor[F]]
Like
writebut returns a pull instead of anF[WriteCursor[F]].