fs2-core/fs2/Chunk

Chunk

object Chunk extends CollectorK[Chunk] with ChunkCompanionPlatform with ChunkCompanionRuntimePlatform
Companion:
class
trait ChunkCompanionPlatform
class Object
trait Matchable
class Any
Chunk.type

Type members

Classlikes

case class ArraySlice[O](values: Array[O], offset: Int, length: Int)(implicit ct: ClassTag[O]) extends Chunk[O]
Companion:
object
object ArraySlice
Companion:
class
sealed abstract class Buffer[A <: Buffer[A, B, C], B <: Buffer, C](buf: B, val offset: Int, val size: Int)(implicit evidence$4: ClassTag[C]) extends Chunk[C]
case class ByteBuffer extends Buffer[ByteBuffer, ByteBuffer, Byte]
Companion:
object
object ByteBuffer
Companion:
class
case class CharBuffer(buf: CharBuffer, offset: Int, size: Int) extends Buffer[CharBuffer, CharBuffer, Char]
Companion:
object
object CharBuffer
Companion:
class
final class Queue[+O] extends Chunk[O]

A FIFO queue of chunks that provides an O(1) size method and provides the ability to take and drop individual elements while preserving the chunk structure as much as possible.

A FIFO queue of chunks that provides an O(1) size method and provides the ability to take and drop individual elements while preserving the chunk structure as much as possible.

This is similar to a queue of individual elements but chunk structure is maintained.

Companion:
object
object Queue
Companion:
class
final class Singleton[O](val value: O) extends Chunk[O]

Inherited classlikes

case class IArraySlice[O](values: IArray[O], offset: Int, length: Int)(implicit ct: ClassTag[O]) extends Chunk[O]
Inherited from:
ChunkCompanionPlatform

Value members

Concrete methods

def apply[O](os: O*): Chunk[O]

Creates a chunk with the specified values.

Creates a chunk with the specified values.

def array[O : ClassTag](values: Array[O]): Chunk[O]

Creates a chunk backed by an array.

Creates a chunk backed by an array.

def array[O : ClassTag](values: Array[O], offset: Int, length: Int): Chunk[O]

Creates a chunk backed by a slice of an array.

Creates a chunk backed by a slice of an array.

def arraySeq[O](arraySeq: ArraySeq[O]): Chunk[O]

Creates a chunk backed by a mutable ArraySeq.

Creates a chunk backed by a mutable ArraySeq.

def byteBuffer(buf: ByteBuffer): Chunk[Byte]

Creates a chunk backed by an byte buffer, bounded by the current position and limit

Creates a chunk backed by an byte buffer, bounded by the current position and limit

def byteVector(bv: ByteVector): Chunk[Byte]

Creates a chunk backed by a byte vector.

Creates a chunk backed by a byte vector.

def chain[O](c: Chain[O]): Chunk[O]

Creates a chunk backed by a Chain.

Creates a chunk backed by a Chain.

def charBuffer(buf: CharBuffer): Chunk[Char]

Creates a chunk backed by an char buffer, bounded by the current position and limit

Creates a chunk backed by an char buffer, bounded by the current position and limit

def concat[A : ClassTag](chunks: Seq[Chunk[A]]): Chunk[A]

Concatenates the specified sequence of chunks in to a single chunk, avoiding boxing.

Concatenates the specified sequence of chunks in to a single chunk, avoiding boxing.

def concat[A : ClassTag](chunks: Seq[Chunk[A]], totalSize: Int): Chunk[A]

Concatenates the specified sequence of chunks in to a single chunk, avoiding boxing. The totalSize parameter must be equal to the sum of the size of each chunk or otherwise an exception may be thrown.

Concatenates the specified sequence of chunks in to a single chunk, avoiding boxing. The totalSize parameter must be equal to the sum of the size of each chunk or otherwise an exception may be thrown.

def empty[A]: Chunk[A]

Chunk with no elements.

Chunk with no elements.

def fromOption[O](opt: Option[O]): Chunk[O]

Creates a singleton chunk or returns an empty one

Creates a singleton chunk or returns an empty one

def indexedSeq[O](s: IndexedSeq[O]): Chunk[O]

Creates a chunk backed by an IndexedSeq.

Creates a chunk backed by an IndexedSeq.

def iterable[O](i: Iterable[O]): Chunk[O]

Creates a chunk from a scala.collection.Iterable.

Creates a chunk from a scala.collection.Iterable.

def iterator[O](itr: Iterator[O]): Chunk[O]

Creates a chunk from a scala.collection.Iterator.

Creates a chunk from a scala.collection.Iterator.

def newBuilder[O]: Builder[O, Chunk[O]]
def queue[A](queue: Queue[A]): Chunk[A]

Creates a chunk consisting of the elements of queue.

Creates a chunk consisting of the elements of queue.

def queueFirstN[A](queue: Queue[A], n: Int): (Chunk[A], Queue[A])

Creates a chunk consisting of the first n elements of queue and returns the remainder.

Creates a chunk consisting of the first n elements of queue and returns the remainder.

def seq[O](s: Seq[O]): Chunk[O]

Creates a chunk from a scala.collection.Seq.

Creates a chunk from a scala.collection.Seq.

def singleton[O](o: O): Chunk[O]

Creates a chunk consisting of a single element.

Creates a chunk consisting of a single element.

def vector[O](v: Vector[O]): Chunk[O]

Creates a chunk backed by a vector.

Creates a chunk backed by a vector.

Deprecated methods

@deprecated("Chunk is no longer specialized for collection.mutable.Buffer - use array or indexedSeq instead", "3.2.4")
def buffer[O](b: Buffer[O]): Chunk[O]

Creates a chunk backed by a mutable buffer. The underlying buffer must not be modified after it is passed to this function.

Creates a chunk backed by a mutable buffer. The underlying buffer must not be modified after it is passed to this function.

Deprecated

Inherited methods

def arraySeq[O](arraySeq: ArraySeq[O]): Chunk[O]

Creates a chunk backed by an immutable ArraySeq.

Creates a chunk backed by an immutable ArraySeq.

Inherited from:
ChunkCompanionPlatform
def iarray[O : ClassTag](arr: IArray[O], offset: Int, length: Int): Chunk[O]

Creates a chunk backed by a slice of an immutable array.

Creates a chunk backed by a slice of an immutable array.

Inherited from:
ChunkCompanionPlatform
def iarray[O : ClassTag](arr: IArray[O]): Chunk[O]

Creates a chunk backed by an immutable array.

Creates a chunk backed by an immutable array.

Inherited from:
ChunkCompanionPlatform
def iterableOnce[O](i: IterableOnce[O]): Chunk[O]

Creates a chunk from a scala.collection.IterableOnce.

Creates a chunk from a scala.collection.IterableOnce.

Inherited from:
ChunkCompanionPlatform
protected def platformIterable[O](i: Iterable[O]): Option[Chunk[O]]
Inherited from:
ChunkCompanionPlatform

Implicits

Implicits

implicit def eqInstance[A](implicit A: Eq[A]): Eq[Chunk[A]]
implicit val instance: Traverse[Chunk] & Monad[Chunk] & Alternative[Chunk] & TraverseFilter[Chunk]

Traverse, Monad, Alternative, and TraverseFilter instance for Chunk.

Traverse, Monad, Alternative, and TraverseFilter instance for Chunk.

implicit def monoidInstance[A]: Monoid[Chunk[A]]