object BatchCursor extends Serializable
- Alphabetic
- By Inheritance
- BatchCursor
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- def apply[A](elems: A*): BatchCursor[A]
Given a list of cursor, builds an array-backed BatchCursor out of it.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def booleans(array: Array[Boolean], offset: Int, length: Int): BooleansCursor
Returns a BatchCursor specialized for
Boolean
.Returns a BatchCursor specialized for
Boolean
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def booleans(array: Array[Boolean]): BooleansCursor
Returns a BatchCursor specialized for
Boolean
.Returns a BatchCursor specialized for
Boolean
.- array
is the underlying reference to use for traversing and transformations
- def bytes(array: Array[Byte], offset: Int, length: Int): BytesCursor
Returns a BatchCursor specialized for
Byte
.Returns a BatchCursor specialized for
Byte
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def bytes(array: Array[Byte]): BytesCursor
Returns a BatchCursor specialized for
Byte
.Returns a BatchCursor specialized for
Byte
.- array
is the underlying reference to use for traversing and transformations
- def chars(array: Array[Char], offset: Int, length: Int): CharsCursor
Returns a BatchCursor specialized for
Char
.Returns a BatchCursor specialized for
Char
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def chars(array: Array[Char]): CharsCursor
Returns a BatchCursor specialized for
Char
.Returns a BatchCursor specialized for
Char
.- array
is the underlying reference to use for traversing and transformations
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def continually[A](f: => A): BatchCursor[A]
Creates an infinite-length iterator returning the results of evaluating an expression.
Creates an infinite-length iterator returning the results of evaluating an expression. The expression is recomputed for every element.
- f
the computation to repeatedly evaluate
- returns
the iterator containing an infinite number of results of evaluating
f
- def doubles(array: Array[Double], offset: Int, length: Int): DoublesCursor
Returns a BatchCursor specialized for
Double
.Returns a BatchCursor specialized for
Double
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def doubles(array: Array[Double]): DoublesCursor
Returns a BatchCursor specialized for
Double
.Returns a BatchCursor specialized for
Double
.- array
is the underlying reference to use for traversing and transformations
- def empty[A]: BatchCursor[A]
Returns a generic, empty cursor instance.
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fromAnyArray[A](array: Array[_]): ArrayCursor[A]
Builds an ArrayCursor instance from any array of boxed values.
Builds an ArrayCursor instance from any array of boxed values.
This will have lower performance than working with BatchCursor.fromArray, since the values are boxed, however there is no requirement for a
ClassTag
and thus it can be used in any generic context.- array
is the underlying reference to use for traversing and transformations
- def fromAnyArray[A](array: Array[_], offset: Int, length: Int): ArrayCursor[A]
Builds an ArrayCursor instance from any array of boxed values.
Builds an ArrayCursor instance from any array of boxed values.
This will have lower performance than working with BatchCursor.fromArray, since the values are boxed, however there is no requirement for a
ClassTag
and thus it can be used in any generic context.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def fromArray[A](array: Array[A], offset: Int, length: Int): ArrayCursor[A]
Builds a BatchCursor from a standard
Array
, with strict semantics on transformations.Builds a BatchCursor from a standard
Array
, with strict semantics on transformations.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def fromArray[A](array: Array[A]): ArrayCursor[A]
Builds a BatchCursor from a standard
Array
, with strict semantics on transformations.Builds a BatchCursor from a standard
Array
, with strict semantics on transformations.- array
is the underlying reference to use for traversing and transformations
- def fromIndexedSeq[A](seq: IndexedSeq[A]): BatchCursor[A]
Builds a BatchCursor from a Scala
IndexedSeq
, with strict semantics on transformations. - def fromIterator[A](iter: Iterator[A], recommendedBatchSize: Int): BatchCursor[A]
Converts a Scala scala.collection.Iterator into a BatchCursor.
Converts a Scala scala.collection.Iterator into a BatchCursor.
- iter
is the Iterator to wrap in a
BatchCursor
instance- recommendedBatchSize
specifies the BatchCursor.recommendedBatchSize for the resulting
BatchCursor
instance, specifying the batch size when doing eager processing.
- def fromIterator[A](iter: Iterator[A]): BatchCursor[A]
Converts a Scala scala.collection.Iterator into a BatchCursor.
Converts a Scala scala.collection.Iterator into a BatchCursor.
- iter
is the Iterator to wrap in a
BatchCursor
instance
- def fromSeq[A](seq: Seq[A], recommendedBatchSize: Int): BatchCursor[A]
Builds a BatchCursor from a Scala
Seq
, with lazy semantics on transformations. - def fromSeq[A](seq: Seq[A]): BatchCursor[A]
Builds a BatchCursor from a Scala
Seq
, with lazy semantics on transformations. - final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def integers(array: Array[Int], offset: Int, length: Int): IntegersCursor
Returns a BatchCursor specialized for
Int
.Returns a BatchCursor specialized for
Int
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def integers(array: Array[Int]): IntegersCursor
Returns a BatchCursor specialized for
Int
.Returns a BatchCursor specialized for
Int
.- array
is the underlying reference to use for traversing and transformations
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def longs(array: Array[Long], offset: Int, length: Int): LongsCursor
Returns a BatchCursor specialized for
Long
.Returns a BatchCursor specialized for
Long
.- array
is the underlying reference to use for traversing and transformations
- offset
is the offset to start from, which would have been zero by default
- length
is the length of created cursor, which would have been
array.length
by default
- def longs(array: Array[Long]): LongsCursor
Returns a BatchCursor specialized for
Long
.Returns a BatchCursor specialized for
Long
.- array
is the underlying reference to use for traversing and transformations
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def range(from: Int, until: Int, step: Int = 1): BatchCursor[Int]
A cursor producing equally spaced values in some integer interval.
A cursor producing equally spaced values in some integer interval.
- from
the start value of the cursor
- until
the end value of the cursor (the first value NOT returned)
- step
the increment value of the cursor (must be positive or negative)
- returns
the cursor producing values
from, from + step, ...
up to, but excludingend
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomic
types, as alternative tojava.util.concurrent.atomic
monix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observable
pattern:Observable
implementationsmonix.tail exposes Iterant for purely functional pull based streaming:
Batch
andBatchCursor
, the alternatives to Scala'sIterable
andIterator
respectively that we are using within Iterant's encodingYou can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.