Class/Object

fs2

Chunk

Related Docs: object Chunk | package fs2

Permalink

abstract class Chunk[+O] extends Serializable

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.

Self Type
Chunk[O]
Source
Chunk.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Chunk
  2. Serializable
  3. Serializable
  4. AnyRef
  5. 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 copyToArray[O2 >: O](xs: Array[O2], start: Int = 0): Unit

    Permalink

    Copies the elements of this chunk in to the specified array at the specified start index.

  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 collect[O2](pf: PartialFunction[O, O2]): Chunk[O2]

    Permalink

    More efficient version of filter(pf.isDefinedAt).map(pf).

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

    Permalink

    Drops the first n elements of this chunk.

  10. 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
  11. 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
  12. 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
  13. 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
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(a: Any): Boolean

    Permalink
    Definition Classes
    Chunk → AnyRef → Any
  16. def filter(p: (O) ⇒ Boolean): Chunk[O]

    Permalink

    Returns a chunk that has only the elements that satisfy the supplied predicate.

  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def find(p: (O) ⇒ Boolean): Option[O]

    Permalink

    Returns the first element for which the predicate returns true or None if no elements satisfy the predicate.

  19. def flatMap[O2](f: (O) ⇒ Chunk[O2]): Chunk[O2]

    Permalink

    Maps f over the elements of this chunk and concatenates the result.

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

    Permalink

    Left-folds the elements of this chunk.

  21. def forall(p: (O) ⇒ Boolean): Boolean

    Permalink

    Returns true if the predicate passes for all elements.

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

    Permalink

    Invokes the supplied function for each element of this chunk.

  23. 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()
  24. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  25. def hashCode(): Int

    Permalink
    Definition Classes
    Chunk → AnyRef → Any
  26. def head: Option[O]

    Permalink

    Gets the first element of this chunk.

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

  28. final def isEmpty: Boolean

    Permalink

    True if size is zero, false otherwise.

  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def iterator: Iterator[O]

    Permalink

    Creates an iterator that iterates the elements of this chunk.

    Creates an iterator that iterates the elements of this chunk. The returned iterator is not thread safe.

  31. def knownElementType[B](implicit classTag: ClassTag[B]): Boolean

    Permalink

    Returns true if this chunk is known to have elements of type B.

    Returns true if this chunk is known to have elements of type B. This is determined by checking if the chunk type mixes in Chunk.KnownElementType.

  32. def last: Option[O]

    Permalink

    Gets the last element of this chunk.

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

    Permalink

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

  34. def mapAccumulate[S, O2](init: S)(f: (S, O) ⇒ (S, O2)): (S, Chunk[O2])

    Permalink

    Maps the supplied stateful function over each element, outputting the final state and the accumulated outputs.

    Maps the supplied stateful function over each element, outputting the final state and the accumulated outputs. The first invocation of f uses init as the input state value. Each successive invocation uses the output state of the previous invocation.

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

    Permalink
    Definition Classes
    AnyRef
  36. final def nonEmpty: Boolean

    Permalink

    False if size is zero, true otherwise.

  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. def reverseIterator: Iterator[O]

    Permalink

    Creates an iterator that iterates the elements of this chunk in reverse order.

    Creates an iterator that iterates the elements of this chunk in reverse order. The returned iterator is not thread safe.

  40. def scanLeft[O2](z: O2)(f: (O2, O) ⇒ O2): Chunk[O2]

    Permalink

    Like foldLeft but emits each intermediate result of f.

  41. def scanLeftCarry[O2](z: O2)(f: (O2, O) ⇒ O2): (Chunk[O2], O2)

    Permalink

    Like scanLeft except the final element is emitted as a standalone value instead of as the last element of the accumulated chunk.

    Like scanLeft except the final element is emitted as a standalone value instead of as the last element of the accumulated chunk.

    Equivalent to val b = a.scanLeft(z)(f); val (c, carry) = b.splitAt(b.size - 1).

  42. def scanLeft_[O2](z: O2, emitFinal: Boolean)(f: (O2, O) ⇒ O2): (Chunk[O2], O2)

    Permalink
    Attributes
    protected
  43. def splitAt(n: Int): (Chunk[O], Chunk[O])

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  45. def take(n: Int): Chunk[O]

    Permalink

    Takes the first n elements of this chunk.

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

    Permalink

    Copies the elements of this chunk to an array.

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

  48. def toByteBuffer[B >: O](implicit ev: =:=[B, Byte]): ByteBuffer

    Permalink

    Converts this chunk to a java.nio.ByteBuffer.

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

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

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

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

  53. def toList: List[O]

    Permalink

    Converts this chunk to a list.

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

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

  56. def toString(): String

    Permalink
    Definition Classes
    Chunk → AnyRef → Any
  57. def toVector: Vector[O]

    Permalink

    Converts this chunk to a vector.

  58. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. def zip[O2](that: Chunk[O2]): Chunk[(O, O2)]

    Permalink

    Zips this chunk the the supplied chunk, returning a chunk of tuples.

  62. def zipWith[O2, O3](that: Chunk[O2])(f: (O, O2) ⇒ O3): Chunk[O3]

    Permalink

    Zips this chunk with the supplied chunk, passing each pair to f, resulting in an output chunk.

  63. 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 Serializable

Inherited from Serializable

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