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
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- 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
- def +(other: String): String
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toany2stringadd[WriteCursor[F]] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (WriteCursor[F], B)
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toArrowAssoc[WriteCursor[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
- 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() @HotSpotIntrinsicCandidate()
- def ensuring(cond: (WriteCursor[F]) => Boolean, msg: => Any): WriteCursor[F]
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toEnsuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (WriteCursor[F]) => Boolean): WriteCursor[F]
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toEnsuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): WriteCursor[F]
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toEnsuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): WriteCursor[F]
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toEnsuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val file: FileHandle[F]
- def formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toStringFormat[WriteCursor[F]] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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]].
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
- Deprecated
(Since version ) see corresponding Javadoc for more information.
- def →[B](y: B): (WriteCursor[F], B)
- Implicit
- This member is added by an implicit conversion from WriteCursor[F] toArrowAssoc[WriteCursor[F]] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.