Packages

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
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteCursor
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new WriteCursor(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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to any2stringadd[WriteCursor[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (WriteCursor[F], B)
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to ArrowAssoc[WriteCursor[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. def ensuring(cond: (WriteCursor[F]) ⇒ Boolean, msg: ⇒ Any): WriteCursor[F]
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to Ensuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (WriteCursor[F]) ⇒ Boolean): WriteCursor[F]
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to Ensuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): WriteCursor[F]
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to Ensuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): WriteCursor[F]
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to Ensuring[WriteCursor[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val file: FileHandle[F]
  14. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to StringFormat[WriteCursor[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. val offset: Long
  21. def seek(position: Long): WriteCursor[F]

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

  22. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. 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.

  27. 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.

  28. def writePull(bytes: Chunk[Byte]): Pull[F, Nothing, WriteCursor[F]]

    Like write but returns a pull instead of an F[WriteCursor[F]].

  29. def →[B](y: B): (WriteCursor[F], B)
    Implicit
    This member is added by an implicit conversion from WriteCursor[F] to ArrowAssoc[WriteCursor[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. 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.

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from WriteCursor[F] to any2stringadd[WriteCursor[F]]

Inherited by implicit conversion StringFormat from WriteCursor[F] to StringFormat[WriteCursor[F]]

Inherited by implicit conversion Ensuring from WriteCursor[F] to Ensuring[WriteCursor[F]]

Inherited by implicit conversion ArrowAssoc from WriteCursor[F] to ArrowAssoc[WriteCursor[F]]

Ungrouped