fs2-docs/fs2/Chunk/CharBuffer

CharBuffer

case class CharBuffer(buf: CharBuffer, offset: Int, size: Int) extends Buffer[CharBuffer, CharBuffer, Char]
Companion:
object
Source:
Chunk.scala
trait Product
trait Equals
class Buffer[CharBuffer, CharBuffer, Char]
class Chunk[Char]
trait Serializable
class Object
trait Matchable
class Any

Value members

Concrete methods

def buffer(b: CharBuffer): CharBuffer
def duplicate(b: CharBuffer): CharBuffer
def get(b: CharBuffer, n: Int): Char
override def get(b: CharBuffer, dest: Array[Char], offset: Int, length: Int): CharBuffer
Definition Classes
Source:
Chunk.scala
def readOnly(b: CharBuffer): CharBuffer
override def toByteVector[B >: Char](implicit ev: B =:= Byte): ByteVector
Definition Classes
Source:
Chunk.scala

Inherited methods

def ++[O2 >: Char](that: Chunk[O2]): Chunk[O2]

Returns a chunk which consists of the elements of this chunk and the elements of the supplied chunk. This operation is amortized O(1).

Returns a chunk which consists of the elements of this chunk and the elements of the supplied chunk. This operation is amortized O(1).

Inherited from:
Chunk
Source:
Chunk.scala
def apply(i: Int): Char
Inherited from:
Buffer
Source:
Chunk.scala
def collect[O2](pf: PartialFunction[Char, O2]): Chunk[O2]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def compact[O2 >: Char](implicit ct: ClassTag[O2]): ArraySlice[O2]

Converts this chunk to a chunk backed by a single array.

Converts this chunk to a chunk backed by a single array.

Alternatively, call toIndexedChunk to get back a chunk with guaranteed O(1) indexed lookup while also minimizing copying.

Inherited from:
Chunk
Source:
Chunk.scala
def copyToArray[O2 >: Char](xs: Array[O2], start: Int): Unit
Inherited from:
Buffer
Source:
Chunk.scala
override def drop(n: Int): Chunk[Char]
Definition Classes
Inherited from:
Buffer
Source:
Chunk.scala
def dropRight(n: Int): Chunk[Char]

Drops the right-most n elements of this chunk queue in a way that preserves chunk structure.

Drops the right-most n elements of this chunk queue in a way that preserves chunk structure.

Inherited from:
Chunk
Source:
Chunk.scala
override def equals(a: Any): Boolean
Definition Classes
Chunk -> Any
Inherited from:
Chunk
Source:
Chunk.scala
def filter(p: Char => Boolean): Chunk[Char]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def find(p: Char => Boolean): Option[Char]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def flatMap[O2](f: Char => Chunk[O2]): Chunk[O2]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def foldLeft[A](init: A)(f: (A, Char) => A): A

Left-folds the elements of this chunk.

Left-folds the elements of this chunk.

Inherited from:
Chunk
Source:
Chunk.scala
def forall(p: Char => Boolean): Boolean

Returns true if the predicate passes for all elements.

Returns true if the predicate passes for all elements.

Inherited from:
Chunk
Source:
Chunk.scala
def foreach(f: Char => Unit): Unit

Invokes the supplied function for each element of this chunk.

Invokes the supplied function for each element of this chunk.

Inherited from:
Chunk
Source:
Chunk.scala
def foreachWithIndex(f: (Char, Int) => Unit): Unit

Like foreach but includes the index of the element.

Like foreach but includes the index of the element.

Inherited from:
Chunk
Source:
Chunk.scala
def head: Option[Char]

Gets the first element of this chunk.

Gets the first element of this chunk.

Inherited from:
Chunk
Source:
Chunk.scala
def indexWhere(p: Char => Boolean): Option[Int]

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.

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.

Inherited from:
Chunk
Source:
Chunk.scala
final def isEmpty: Boolean

True if size is zero, false otherwise.

True if size is zero, false otherwise.

Inherited from:
Chunk
Source:
Chunk.scala
def iterator: Iterator[Char]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def last: Option[Char]

Gets the last element of this chunk.

Gets the last element of this chunk.

Inherited from:
Chunk
Source:
Chunk.scala
def map[O2](f: Char => O2): Chunk[O2]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def mapAccumulate[S, O2](init: S)(f: (S, Char) => (S, O2)): (S, Chunk[O2])

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.

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.

Inherited from:
Chunk
Source:
Chunk.scala
def mapFilter[O2](f: Char => Option[O2]): Chunk[O2]

Maps the supplied function over each element and returns a chunk of just the defined results.

Maps the supplied function over each element and returns a chunk of just the defined results.

Inherited from:
Chunk
Source:
Chunk.scala
final def nonEmpty: Boolean

False if size is zero, true otherwise.

False if size is zero, true otherwise.

Inherited from:
Chunk
Source:
Chunk.scala
def productIterator: Iterator[Any]
Inherited from:
Product
def reverseIterator: Iterator[Char]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def scanLeft[O2](z: O2)(f: (O2, Char) => O2): Chunk[O2]

Like foldLeft but emits each intermediate result of f.

Like foldLeft but emits each intermediate result of f.

Inherited from:
Chunk
Source:
Chunk.scala
def scanLeftCarry[O2](z: O2)(f: (O2, Char) => O2): (Chunk[O2], O2)

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

Inherited from:
Chunk
Source:
Chunk.scala
def splitAt(n: Int): (Chunk[Char], Chunk[Char])

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

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

Inherited from:
Chunk
Source:
Chunk.scala
protected def splitAtChunk_(n: Int): (CharBuffer, CharBuffer)
Inherited from:
Buffer
Source:
Chunk.scala
def startsWith[O2 >: Char](seq: Seq[O2]): Boolean

Check to see if this starts with the items in the given seq.

Check to see if this starts with the items in the given seq.

Inherited from:
Chunk
Source:
Chunk.scala
override def take(n: Int): Chunk[Char]
Definition Classes
Inherited from:
Buffer
Source:
Chunk.scala
def takeRight(n: Int): Chunk[Char]

Takes the right-most n elements of this chunk queue in a way that preserves chunk structure.

Takes the right-most n elements of this chunk queue in a way that preserves chunk structure.

Inherited from:
Chunk
Source:
Chunk.scala
def to(collector: Collector[Char]): Out

Converts this chunk to a new collection using the supplied collector.

Converts this chunk to a new collection using the supplied collector.

Example:
scala> Chunk(1, 2, 3).to(Set)
Inherited from:
Chunk
Source:
Chunk.scala
override def toArray[O2 >: Char : ClassTag]: Array[O2]
Definition Classes
Inherited from:
Buffer
Source:
Chunk.scala
def toArraySlice[O2 >: Char](implicit ct: ClassTag[O2]): ArraySlice[O2]

Converts this chunk to a Chunk.ArraySlice.

Converts this chunk to a Chunk.ArraySlice.

Inherited from:
Chunk
Source:
Chunk.scala
def toBitVector[B >: Char](implicit ev: B =:= Byte): BitVector

Converts this chunk to a scodec-bits BitVector.

Converts this chunk to a scodec-bits BitVector.

Inherited from:
Chunk
Source:
Chunk.scala
def toByteBuffer[B >: Char](implicit ev: B =:= Byte): ByteBuffer

Converts this chunk to a java.nio.ByteBuffer.

Converts this chunk to a java.nio.ByteBuffer.

Inherited from:
Chunk
Source:
Chunk.scala
def toChain: Chain[Char]

Converts this chunk to a chain.

Converts this chunk to a chain.

Inherited from:
Chunk
Source:
Chunk.scala
def toIArray[O2 >: Char : ClassTag]: IArray[O2]
def toIArraySlice[O2 >: Char](implicit ct: ClassTag[O2]): IArraySlice[O2]
def toIndexedChunk: Chunk[Char]

Returns a chunk with guaranteed O(1) lookup by index.

Returns a chunk with guaranteed O(1) lookup by index.

Unlike compact, this operation does not copy any elements unless this chunk does not provide O(1) lookup by index -- e.g., a chunk built via 1 or more usages of ++.

Inherited from:
Chunk
Source:
Chunk.scala
def toList: List[Char]

Converts this chunk to a list.

Converts this chunk to a list.

Inherited from:
Chunk
Source:
Chunk.scala
def toNel: Option[NonEmptyList[Char]]

Converts this chunk to a NonEmptyList

Converts this chunk to a NonEmptyList

Inherited from:
Chunk
Source:
Chunk.scala
override def toString: String
Definition Classes
Chunk -> Any
Inherited from:
Chunk
Source:
Chunk.scala
def toVector: Vector[Char]

Converts this chunk to a vector.

Converts this chunk to a vector.

Inherited from:
Chunk
Source:
Chunk.scala
def traverse[F[_], O2](f: Char => F[O2])(implicit F: Applicative[F]): F[Chunk[O2]]
Inherited from:
Chunk
Source:
Chunk.scala
def traverseFilter[F[_], O2](f: Char => F[Option[O2]])(implicit F: Applicative[F]): F[Chunk[O2]]
Inherited from:
Chunk
Source:
Chunk.scala
def zip[O2](that: Chunk[O2]): Chunk[(Char, O2)]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def zipWith[O2, O3](that: Chunk[O2])(f: (Char, O2) => O3): Chunk[O3]

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

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

Inherited from:
Chunk
Source:
Chunk.scala
def zipWithIndex: Chunk[(Char, Int)]

Zips the elements of the input chunk with its indices, and returns the new chunk.

Zips the elements of the input chunk with its indices, and returns the new chunk.

Example:
scala> Chunk("The", "quick", "brown", "fox").zipWithIndex.toList
res0: List[(String, Int)] = List((The,0), (quick,1), (brown,2), (fox,3))
Inherited from:
Chunk
Source:
Chunk.scala

Deprecated and Inherited methods

@deprecated("Unsound when used with primitives, use compactBoxed instead", "3.1.6")
def compactUntagged[O2 >: Char]: ArraySlice[O2]

Like compact but does not require a ClassTag. Elements are boxed and stored in an Array[Any].

Like compact but does not require a ClassTag. Elements are boxed and stored in an Array[Any].

Deprecated
Inherited from:
Chunk
Source:
Chunk.scala