final class Apply[F[_]] extends AnyVal
See the description on IterantBuilders for the purpose of this class.
Class defined inside object due to Scala's limitations on declaring
AnyVal classes.
- Source
- IterantBuilders.scala
- Alphabetic
- By Inheritance
- Apply
- AnyVal
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##(): Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def channel[A](bufferCapacity: BufferCapacity = Bounded(recommendedBufferChunkSize), maxBatchSize: Int = recommendedBufferChunkSize, producerType: ProducerSide = MultiProducer)(implicit F: Concurrent[F], cs: ContextShift[F]): F[(ProducerF[F, Option[Throwable], A], Iterant[F, A])]
Aliased builder, see documentation for Iterant.channel.
- def concatS[A](lh: F[Iterant[F, A]], rh: F[Iterant[F, A]]): Iterant[F, A]
Aliased builder, see documentation for Iterant.concatS.
- def defer[A](fa: => Iterant[F, A])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.defer.
- def delay[A](a: => A)(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.eval.
- def empty[A]: Iterant[F, A]
Aliased builder, see documentation for Iterant.empty.
- def eval[A](a: => A)(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.eval.
- def fromArray[A](xs: Array[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromArray.
- def fromBatch[A](xs: Batch[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromBatch.
- def fromBatchCursor[A](xs: BatchCursor[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromBatchCursor.
- def fromChannel[A](channel: Channel[F, A], bufferCapacity: BufferCapacity = Bounded(recommendedBufferChunkSize), maxBatchSize: Int = recommendedBufferChunkSize)(implicit F: Async[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromChannel.
- def fromConsumer[A](consumer: ConsumerF[F, Option[Throwable], A], maxBatchSize: Int = recommendedBufferChunkSize)(implicit F: Async[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromConsumer.
- def fromIndexedSeq[A](xs: IndexedSeq[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromIndexedSeq.
- def fromIterable[A](xs: Iterable[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromIterable.
- def fromIterator[A](xs: Iterator[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromIterator.
- def fromList[A](xs: LinearSeq[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromList.
- def fromReactivePublisher[A](publisher: Publisher[A], requestCount: Int = recommendedBufferChunkSize, eagerBuffer: Boolean = true)(implicit F: Async[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromReactivePublisher.
- def fromResource[A](r: Resource[F, A])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromResource.
- def fromSeq[A](xs: Seq[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromSeq.
- def fromStateAction[S, A](f: (S) => (A, S))(seed: => S)(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromStateAction.
- def fromStateActionL[S, A](f: (S) => F[(A, S)])(seed: => F[S])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.fromLazyStateAction.
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- def haltS[A](e: Option[Throwable]): Iterant[F, A]
Aliased builder, see documentation for Iterant.haltS.
- def intervalAtFixedRate(initialDelay: FiniteDuration, period: FiniteDuration)(implicit F: Async[F], timer: Timer[F]): Iterant[F, Long]
Aliased builder, see documentation for Iterant.intervalAtFixedRate.
- def intervalAtFixedRate(period: FiniteDuration)(implicit F: Async[F], timer: Timer[F]): Iterant[F, Long]
Aliased builder, see documentation for Iterant.intervalAtFixedRate.
- def intervalWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration)(implicit F: Async[F], timer: Timer[F]): Iterant[F, Long]
Aliased builder, see documentation for Iterant.intervalAtFixedRate.
- def intervalWithFixedDelay(delay: FiniteDuration)(implicit F: Async[F], timer: Timer[F]): Iterant[F, Long]
Aliased builder, see documentation for Iterant.intervalAtFixedRate.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def lastS[A](item: A): Iterant[F, A]
Aliased builder, see documentation for Iterant.lastS.
- def liftF[A](a: F[A])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.liftF.
- def never[A](implicit F: Async[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.never.
- def nextBatchS[A](batch: Batch[A], rest: F[Iterant[F, A]]): Iterant[F, A]
Aliased builder, see documentation for Iterant.nextBatchS.
- def nextCursorS[A](cursor: BatchCursor[A], rest: F[Iterant[F, A]]): Iterant[F, A]
Aliased builder, see documentation for Iterant.nextCursorS.
- def nextS[A](item: A, rest: F[Iterant[F, A]]): Iterant[F, A]
Aliased builder, see documentation for Iterant.nextS.
- def now[A](a: A): Iterant[F, A]
Aliased builder, see documentation for Iterant.now.
- def of[A](elems: A*)(implicit F: Applicative[F]): Iterant[F, A]
Given a list of elements build a stream out of it.
- def pure[A](a: A): Iterant[F, A]
Aliased builder, see documentation for Iterant.pure.
- def raiseError[A](ex: Throwable): Iterant[F, A]
Aliased builder, see documentation for Iterant.raiseError.
- def range(from: Int, until: Int, step: Int = 1)(implicit F: Applicative[F]): Iterant[F, Int]
Aliased builder, see documentation for Iterant.range.
- def repeat[A](elems: A*)(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.repeat.
- def repeatEval[A](thunk: => A)(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.repeatEval.
- def repeatEvalF[A](fa: F[A])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.repeatEvalF.
- def resource[A](acquire: F[A])(release: (A) => F[Unit])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.resource.
- def resourceCase[A](acquire: F[A])(release: (A, ExitCase[Throwable]) => F[Unit])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.resourceCase.
- def scopeS[A, B](acquire: F[A], use: (A) => F[Iterant[F, B]], close: (A, ExitCase[Throwable]) => F[Unit]): Iterant[F, B]
Aliased builder, see documentation for Iterant.scopeS.
- def suspend[A](fa: => Iterant[F, A])(implicit F: Sync[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.suspend.
- def suspend[A](rest: F[Iterant[F, A]])(implicit F: Applicative[F]): Iterant[F, A]
Aliased builder, see documentation for Iterant.suspend.
- def suspendS[A](rest: F[Iterant[F, A]]): Iterant[F, A]
Aliased builder, see documentation for Iterant.suspendS.
- def tailRecM[A, B](a: A)(f: (A) => Iterant[F, Either[A, B]])(implicit F: Sync[F]): Iterant[F, B]
Aliased builder, see documentation for Iterant.tailRecM.
- def toString(): String
- Definition Classes
- Any
- val v: Boolean
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomictypes, as alternative tojava.util.concurrent.atomicmonix.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
Observablepattern:Observableimplementationsmonix.tail exposes Iterant for purely functional pull based streaming:
BatchandBatchCursor, the alternatives to Scala'sIterableandIteratorrespectively 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.