fs2-docs
3.7.0-RC5
API
Generated with
fs2-docs/fs2/Chunk

Chunk

fs2.Chunk$
See theChunk companion class
object Chunk extends CollectorK[Chunk]

Attributes

Companion:
class
Source:
Chunk.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Chunk.type

Members list

Concise view

Type members

Classlikes

case class ArraySlice[O](values: Array[O], offset: Int, length: Int)(implicit ct: ClassTag[O]) extends Chunk[O]

Attributes

Companion:
object
Source:
Chunk.scala
Graph
Supertypes
trait Product
trait Equals
class Chunk[O]
trait Serializable
class Object
trait Matchable
class Any
object ArraySlice

Attributes

Companion:
class
Source:
Chunk.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class Buffer[A <: Buffer[A, B, C], B <: Buffer, C](buf: B, val offset: Int, val size: Int)(implicit ct: ClassTag[C]) extends Chunk[C]

Attributes

Source:
Chunk.scala
Graph
Supertypes
class Chunk[C]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
case class ByteBuffer extends Buffer[ByteBuffer, ByteBuffer, Byte]

Attributes

Companion:
object
Source:
Chunk.scala
Graph
Supertypes
trait Product
trait Equals
class Buffer[ByteBuffer, ByteBuffer, Byte]
class Chunk[Byte]
trait Serializable
class Object
trait Matchable
class Any
object ByteBuffer

Attributes

Companion:
class
Source:
Chunk.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class CharBuffer(buf: CharBuffer, offset: Int, size: Int) extends Buffer[CharBuffer, CharBuffer, Char]

Attributes

Companion:
object
Source:
Chunk.scala
Graph
Supertypes
trait Product
trait Equals
class Buffer[CharBuffer, CharBuffer, Char]
class Chunk[Char]
trait Serializable
class Object
trait Matchable
class Any
object CharBuffer

Attributes

Companion:
class
Source:
Chunk.scala
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
final class Constant[A](value: A, val size: Int) extends Chunk[A]

Attributes

Source:
Chunk.scala
Graph
Supertypes
class Chunk[A]
trait Serializable
class Object
trait Matchable
class Any
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.

Attributes

Companion:
object
Source:
Chunk.scala
Graph
Supertypes
class Chunk[O]
trait Serializable
class Object
trait Matchable
class Any
object Queue

Attributes

Companion:
class
Source:
Chunk.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Queue.type
final class Singleton[O](val value: O) extends Chunk[O]

Attributes

Source:
Chunk.scala
Graph
Supertypes
class Chunk[O]
trait Serializable
class Object
trait Matchable
class Any

Inherited classlikes

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

Attributes

Inherited from:
ChunkCompanionPlatform (hidden)
Source:
ChunkPlatform.scala
Graph
Supertypes
trait Product
trait Equals
class Chunk[O]
trait Serializable
class Object
trait Matchable
class Any

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.

Attributes

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

Creates a chunk backed by an array.

Creates a chunk backed by an array.

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
def arraySeq[O](arraySeq: ArraySeq[O]): Chunk[O]

Creates a chunk backed by a mutable ArraySeq.

Creates a chunk backed by a mutable ArraySeq.

Attributes

Source:
Chunk.scala
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

Attributes

Source:
Chunk.scala
def byteVector(bv: ByteVector): Chunk[Byte]

Creates a chunk backed by a byte vector.

Creates a chunk backed by a byte vector.

Attributes

Source:
Chunk.scala
def chain[O](c: Chain[O]): Chunk[O]

Creates a chunk backed by a Chain.

Creates a chunk backed by a Chain.

Attributes

Source:
Chunk.scala
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

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
def constant[A](value: A, size: Int): Chunk[A]

Attributes

Source:
Chunk.scala
def empty[A]: Chunk[A]

Chunk with no elements.

Chunk with no elements.

Attributes

Source:
Chunk.scala
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

Attributes

Source:
Chunk.scala
def indexedSeq[O](s: IndexedSeq[O]): Chunk[O]

Creates a chunk backed by an IndexedSeq.

Creates a chunk backed by an IndexedSeq.

Attributes

Source:
Chunk.scala
def iterable[O](i: Iterable[O]): Chunk[O]

Creates a chunk from a scala.collection.Iterable.

Creates a chunk from a scala.collection.Iterable.

Attributes

Source:
Chunk.scala
def iterator[O](itr: Iterator[O]): Chunk[O]

Creates a chunk from a scala.collection.Iterator.

Creates a chunk from a scala.collection.Iterator.

Attributes

Source:
Chunk.scala
def newBuilder[O]: Builder[O, Chunk[O]]

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
def seq[O](s: Seq[O]): Chunk[O]

Creates a chunk from a scala.collection.Seq.

Creates a chunk from a scala.collection.Seq.

Attributes

Source:
Chunk.scala
def singleton[O](o: O): Chunk[O]

Creates a chunk consisting of a single element.

Creates a chunk consisting of a single element.

Attributes

Source:
Chunk.scala
def vector[O](v: Vector[O]): Chunk[O]

Creates a chunk backed by a vector.

Creates a chunk backed by a vector.

Attributes

Source:
Chunk.scala

Deprecated methods

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.

Attributes

Deprecated
true
Source:
Chunk.scala

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.

Attributes

Inherited from:
ChunkCompanionPlatform (hidden)
Source:
ChunkPlatform.scala
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.

Attributes

Inherited from:
ChunkCompanionPlatform (hidden)
Source:
ChunkPlatform.scala
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.

Attributes

Inherited from:
ChunkCompanionPlatform (hidden)
Source:
ChunkPlatform.scala
def iterableOnce[O](i: IterableOnce[O]): Chunk[O]

Creates a chunk from a scala.collection.IterableOnce.

Creates a chunk from a scala.collection.IterableOnce.

Attributes

Inherited from:
ChunkCompanionPlatform (hidden)
Source:
ChunkPlatform.scala
protected def platformIterable[O](i: Iterable[O]): Option[Chunk[O]]

Implicits

Implicits

implicit def eqInstance[A](implicit A: Eq[A]): Eq[Chunk[A]]

Attributes

Source:
Chunk.scala
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.

Attributes

Source:
Chunk.scala
implicit def monoidInstance[A]: Monoid[Chunk[A]]

Attributes

Source:
Chunk.scala
Generated with