Class/Object

fs2

Chunk

Related Docs: object Chunk | package fs2

Permalink

abstract class Chunk[+O] extends AnyRef

Strict, finite sequence of values that allows index-based random access of elements.

Chunks can be created from a variety of collection types using methods on the Chunk companion (e.g., Chunk.vector, Chunk.seq, Chunk.array). Additionally, the Chunk companion defines a subtype of Chunk for each primitive type, using an unboxed primitive array. To work with unboxed arrays, use methods like toBytes to convert a Chunk[Byte] to a Chunk.Bytes and then access the array directly.

The operations on Chunk are all defined strictly. For example, c.map(f).map(g).map(h) results in intermediate chunks being created (1 per call to map). In contrast, a chunk can be lifted to a segment (via toSegment) to get arbitrary operator fusion.

Source
Chunk.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Booleans, Boxed, Bytes, Doubles, Floats, Ints, Longs, Shorts
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Chunk
  2. AnyRef
  3. 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 Chunk()

    Permalink

Abstract Value Members

  1. abstract def apply(i: Int): O

    Permalink

    Returns the element at the specified index.

    Returns the element at the specified index. Throws if index is < 0 or >= size.

  2. abstract def map[O2](f: (O) ⇒ O2): Chunk[O2]

    Permalink

    Creates a new chunk by applying f to each element in this chunk.

  3. abstract def size: Int

    Permalink

    Returns the number of elements in this chunk.

  4. abstract def splitAtChunk_(n: Int): (Chunk[O], Chunk[O])

    Permalink

    Splits this chunk in to two chunks at the specified index n, which is guaranteed to be in-bounds.

    Splits this chunk in to two chunks at the specified index n, which is guaranteed to be in-bounds.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to any2stringadd[Chunk[O]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Chunk[O], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to ArrowAssoc[Chunk[O]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def drop(n: Int): Chunk[O]

    Permalink

    Drops the first n elements of this chunk.

  9. def ensuring(cond: (Chunk[O]) ⇒ Boolean, msg: ⇒ Any): Chunk[O]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to Ensuring[Chunk[O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: (Chunk[O]) ⇒ Boolean): Chunk[O]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to Ensuring[Chunk[O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean, msg: ⇒ Any): Chunk[O]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to Ensuring[Chunk[O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean): Chunk[O]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to Ensuring[Chunk[O]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(a: Any): Boolean

    Permalink
    Definition Classes
    Chunk → AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. def foldLeft[A](init: A)(f: (A, O) ⇒ A): A

    Permalink

    Left-folds the elements of this chunk.

  17. def foreach(f: (O) ⇒ Unit): Unit

    Permalink

    Invokes the supplied function for each element of this chunk.

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to StringFormat[Chunk[O]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Permalink
    Definition Classes
    Chunk → AnyRef → Any

  21. def head: Option[O]

    Permalink

    Gets the first element of this chunk.

  22. def indexWhere(p: (O) ⇒ Boolean): Option[Int]

    Permalink

    Returns the index of the first element which passes the specified predicate (i.e., p(i) == true) or None if no elements pass the predicate.

  23. final def isEmpty: Boolean

    Permalink

    True if size is zero, false otherwise.

  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  25. def last: Option[O]

    Permalink

    Gets the last element of this chunk.

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. final def nonEmpty: Boolean

    Permalink

    False if size is zero, true otherwise.

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. def splitAt(n: Int): (Chunk[O], Chunk[O])

    Permalink

    Splits this chunk in to two chunks at the specified index.

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  32. def take(n: Int): Chunk[O]

    Permalink

    Takes the first n elements of this chunk.

  33. def toArray[O2 >: O](implicit arg0: ClassTag[O2]): Array[O2]

    Permalink

    Copies the elements of this chunk to an array.

  34. def toBooleans[B >: O](implicit ev: =:=[B, Boolean]): Booleans

    Permalink

    Converts this chunk to a Chunk.Booleans, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Booleans, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of booleans, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  35. def toBytes[B >: O](implicit ev: =:=[B, Byte]): Bytes

    Permalink

    Converts this chunk to a Chunk.Bytes, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Bytes, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of bytes, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  36. def toDoubles[B >: O](implicit ev: =:=[B, Double]): Doubles

    Permalink

    Converts this chunk to a Chunk.Doubles, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Doubles, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of doubles, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  37. def toFloats[B >: O](implicit ev: =:=[B, Float]): Floats

    Permalink

    Converts this chunk to a Chunk.Floats, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Floats, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of doubles, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  38. def toInts[B >: O](implicit ev: =:=[B, Int]): Ints

    Permalink

    Converts this chunk to a Chunk.Ints, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Ints, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of bytes, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  39. def toList: List[O]

    Permalink

    Converts this chunk to a list.

  40. def toLongs[B >: O](implicit ev: =:=[B, Long]): Longs

    Permalink

    Converts this chunk to a Chunk.Longs, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Longs, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of longs, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  41. def toSegment: Segment[O, Unit]

    Permalink

    Converts this chunk to a segment.

  42. def toShorts[B >: O](implicit ev: =:=[B, Short]): Shorts

    Permalink

    Converts this chunk to a Chunk.Shorts, allowing access to the underlying array of elements.

    Converts this chunk to a Chunk.Shorts, allowing access to the underlying array of elements. If this chunk is already backed by an unboxed array of bytes, this method runs in constant time. Otherwise, this method will copy of the elements of this chunk in to a single array.

  43. def toString(): String

    Permalink
    Definition Classes
    Chunk → AnyRef → Any

  44. def toVector: Vector[O]

    Permalink

    Converts this chunk to a vector.

  45. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  46. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  47. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  48. def →[B](y: B): (Chunk[O], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Chunk[O] to ArrowAssoc[Chunk[O]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Chunk[O] to any2stringadd[Chunk[O]]

Inherited by implicit conversion StringFormat from Chunk[O] to StringFormat[Chunk[O]]

Inherited by implicit conversion Ensuring from Chunk[O] to Ensuring[Chunk[O]]

Inherited by implicit conversion ArrowAssoc from Chunk[O] to ArrowAssoc[Chunk[O]]

Ungrouped