Packages

c

monix.tail

IterantBuildersAsync

class IterantBuildersAsync[F[_]] extends IterantBuildersSync[F]

Class defining curried Iterant builders for data types that implement cats.effect.Async.

So instead of having to do:

Iterant.intervalAtFixedRate[Task](1.second)

You can do:

Iterant[Task].intervalAtFixedRate(1.second)
Linear Supertypes
IterantBuildersSync[F], IterantBuildersApplicative[F], IterantBuilders[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IterantBuildersAsync
  2. IterantBuildersSync
  3. IterantBuildersApplicative
  4. IterantBuilders
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new IterantBuildersAsync()(implicit F: Async[F])

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def bracket[A, B](acquire: F[A])(use: (A) ⇒ Iterant[F, B], release: (A) ⇒ F[Unit])(implicit F: Sync[F]): Iterant[F, B]

    Aliased builder, see documentation for Iterant.bracket

    Aliased builder, see documentation for Iterant.bracket

    Definition Classes
    IterantBuildersSync
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. def defer[A](fa: ⇒ Iterant[F, A])(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.defer.

    Aliased builder, see documentation for Iterant.defer.

    Definition Classes
    IterantBuildersSync
  8. def empty[A]: Iterant[F, A]

    Aliased builder, see documentation for Iterant.empty.

    Aliased builder, see documentation for Iterant.empty.

    Definition Classes
    IterantBuilders
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  11. def eval[A](a: ⇒ A)(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.eval.

    Aliased builder, see documentation for Iterant.eval.

    Definition Classes
    IterantBuildersSync
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. def fromArray[A](xs: Array[A])(implicit arg0: ClassTag[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromArray.

    Aliased builder, see documentation for Iterant.fromArray.

    Definition Classes
    IterantBuildersApplicative
  14. def fromIndexedSeq[A](xs: IndexedSeq[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromIndexedSeq.

    Aliased builder, see documentation for Iterant.fromIndexedSeq.

    Definition Classes
    IterantBuildersApplicative
  15. def fromIterable[A](xs: Iterable[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromIterable.

    Aliased builder, see documentation for Iterant.fromIterable.

    Definition Classes
    IterantBuildersApplicative
  16. def fromIterator[A](xs: Iterator[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromIterator.

    Aliased builder, see documentation for Iterant.fromIterator.

    Definition Classes
    IterantBuildersApplicative
  17. def fromList[A](xs: LinearSeq[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromList.

    Aliased builder, see documentation for Iterant.fromList.

    Definition Classes
    IterantBuildersApplicative
  18. def fromSeq[A](xs: Seq[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromSeq.

    Aliased builder, see documentation for Iterant.fromSeq.

    Definition Classes
    IterantBuildersApplicative
  19. def fromStateAction[S, A](f: (S) ⇒ (A, S))(seed: ⇒ S)(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.fromStateAction.

    Aliased builder, see documentation for Iterant.fromStateAction.

    Definition Classes
    IterantBuildersSync
  20. 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.fromStateActionL.

    Aliased builder, see documentation for Iterant.fromStateActionL.

    Definition Classes
    IterantBuildersSync
  21. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  22. def haltS[A](e: Option[Throwable]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.haltS.

    Aliased builder, see documentation for Iterant.haltS.

    Definition Classes
    IterantBuilders
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def intervalAtFixedRate(initialDelay: FiniteDuration, period: FiniteDuration)(implicit timer: Timer[F]): Iterant[F, Long]

    Creates an iterant that emits auto-incremented natural numbers (longs).

    Creates an iterant that emits auto-incremented natural numbers (longs). at a fixed rate, as given by the specified period. The amount of time it takes to process an incoming value gets subtracted from provided period, thus created iterant tries to emit events spaced by the given time interval, regardless of how long further processing takes

    This version of the intervalAtFixedRate allows specifying an initialDelay before first value is emitted

    initialDelay

    initial delay before emitting the first value

    period

    period between 2 successive emitted values

    timer

    is the timer implementation used to generate delays and to fetch the current time

  25. def intervalAtFixedRate(period: FiniteDuration)(implicit timer: Timer[F]): Iterant[F, Long]

    Creates an iterant that emits auto-incremented natural numbers (longs).

    Creates an iterant that emits auto-incremented natural numbers (longs). at a fixed rate, as given by the specified period. The amount of time it takes to process an incoming value gets subtracted from provided period, thus created iterant tries to emit events spaced by the given time interval, regardless of how long further processing takes

    period

    period between 2 successive emitted values

    timer

    is the timer implementation used to generate delays and to fetch the current time

  26. def intervalWithFixedDelay(initialDelay: FiniteDuration, delay: FiniteDuration)(implicit timer: Timer[F]): Iterant[F, Long]

    Creates an iterant that emits auto-incremented natural numbers (longs) spaced by a given time interval.

    Creates an iterant that emits auto-incremented natural numbers (longs) spaced by a given time interval. Starts from 0 with no delay, after which it emits incremented numbers spaced by the period of time. The given period of time acts as a fixed delay between successive events.

    initialDelay

    is the delay to wait before emitting the first event

    delay

    the time to wait between 2 successive events

    timer

    is the timer implementation used to generate delays and to fetch the current time

  27. def intervalWithFixedDelay(delay: FiniteDuration)(implicit timer: Timer[F]): Iterant[F, Long]

    Creates an iterant that emits auto-incremented natural numbers (longs) spaced by a given time interval.

    Creates an iterant that emits auto-incremented natural numbers (longs) spaced by a given time interval. Starts from 0 with no delay, after which it emits incremented numbers spaced by the period of time. The given period of time acts as a fixed delay between successive events.

    Without having an initial delay specified, this overload will immediately emit the first item, without any delays.

    delay

    the time to wait between 2 successive events

    timer

    is the timer implementation used to generate delays and to fetch the current time

  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def lastS[A](item: A): Iterant[F, A]

    Aliased builder, see documentation for Iterant.lastS.

    Aliased builder, see documentation for Iterant.lastS.

    Definition Classes
    IterantBuilders
  30. def liftF[A](a: F[A]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.liftF.

    Aliased builder, see documentation for Iterant.liftF.

    Definition Classes
    IterantBuildersApplicative
  31. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  32. def nextBatchS[A](batch: Batch[A], rest: F[Iterant[F, A]], stop: F[Unit]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.nextBatchS.

    Aliased builder, see documentation for Iterant.nextBatchS.

    Definition Classes
    IterantBuilders
  33. def nextCursorS[A](cursor: BatchCursor[A], rest: F[Iterant[F, A]], stop: F[Unit]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.nextCursorS.

    Aliased builder, see documentation for Iterant.nextCursorS.

    Definition Classes
    IterantBuilders
  34. def nextS[A](item: A, rest: F[Iterant[F, A]], stop: F[Unit]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.nextS.

    Aliased builder, see documentation for Iterant.nextS.

    Definition Classes
    IterantBuilders
  35. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  36. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. def now[A](a: A): Iterant[F, A]

    Aliased builder, see documentation for Iterant.now.

    Aliased builder, see documentation for Iterant.now.

    Definition Classes
    IterantBuilders
  38. def of[A](elems: A*): Iterant[F, A]

    Given a list of elements build a stream out of it.

    Given a list of elements build a stream out of it.

    Definition Classes
    IterantBuildersApplicative
  39. def pure[A](a: A): Iterant[F, A]

    Aliased builder, see documentation for Iterant.pure.

    Aliased builder, see documentation for Iterant.pure.

    Definition Classes
    IterantBuilders
  40. def raiseError[A](ex: Throwable): Iterant[F, A]

    Aliased builder, see documentation for Iterant.raiseError.

    Aliased builder, see documentation for Iterant.raiseError.

    Definition Classes
    IterantBuilders
  41. def range(from: Int, until: Int, step: Int = 1): Iterant[F, Int]

    Aliased builder, see documentation for Iterant.range.

    Aliased builder, see documentation for Iterant.range.

    Definition Classes
    IterantBuildersApplicative
  42. def repeat[A](elems: A*)(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.repeat.

    Aliased builder, see documentation for Iterant.repeat.

    Definition Classes
    IterantBuildersSync
  43. def repeatEval[A](thunk: ⇒ A)(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.repeatEval.

    Aliased builder, see documentation for Iterant.repeatEval.

    Definition Classes
    IterantBuildersSync
  44. def repeatEvalF[A](fa: F[A])(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.repeatEvalF.

    Aliased builder, see documentation for Iterant.repeatEvalF.

    Definition Classes
    IterantBuildersSync
  45. def suspend[A](fa: ⇒ Iterant[F, A])(implicit F: Sync[F]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.suspend.

    Aliased builder, see documentation for Iterant.suspend.

    Definition Classes
    IterantBuildersSync
  46. def suspend[A](rest: F[Iterant[F, A]]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.suspend.

    Aliased builder, see documentation for Iterant.suspend.

    Definition Classes
    IterantBuildersApplicative
  47. def suspendS[A](rest: F[Iterant[F, A]], stop: F[Unit]): Iterant[F, A]

    Aliased builder, see documentation for Iterant.suspendS.

    Aliased builder, see documentation for Iterant.suspendS.

    Definition Classes
    IterantBuilders
  48. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  49. 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.

    Aliased builder, see documentation for Iterant.tailRecM.

    Definition Classes
    IterantBuildersSync
  50. def toString(): String
    Definition Classes
    AnyRef → Any
  51. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  52. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from IterantBuildersSync[F]

Inherited from IterantBuildersApplicative[F]

Inherited from IterantBuilders[F]

Inherited from AnyRef

Inherited from Any

Ungrouped