Object/Class

cats.data

Streaming

Related Docs: class Streaming | package data

Permalink

object Streaming extends StreamingInstances

Linear Supertypes
StreamingInstances, StreamingInstances1, StreamingInstances2, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Streaming
  2. StreamingInstances
  3. StreamingInstances1
  4. StreamingInstances2
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. final case class Cons[A](a: A, tail: Eval[Streaming[A]]) extends Streaming[A] with Product with Serializable

    Permalink
  2. final case class Empty[A]() extends Streaming[A] with Product with Serializable

    Permalink

    Concrete Streaming[A] types:

    Concrete Streaming[A] types:

    • Empty(): an empty stream.
    • Cons(a, tail): a non-empty stream containing (at least) a.
    • Wait(tail): a deferred stream.

    Cons represents a lazy, possibly infinite stream of values. Eval[_] is used to represent possible laziness (via Now, Later, and Always). The head of Cons is eager -- a lazy head can be represented using Wait(Always(...)) or Wait(Later(...)).

  3. final case class Wait[A](next: Eval[Streaming[A]]) extends Streaming[A] with Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def apply[A](a1: A, a2: A, as: A*): Streaming[A]

    Permalink

    Create a stream from two or more values.

  5. def apply[A](a: A): Streaming[A]

    Permalink

    Create a stream consisting of a single value.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def cons[A](a: A, ls: Eval[Streaming[A]]): Streaming[A]

    Permalink

    Prepend a value to an Eval[Streaming[A]].

  9. def cons[A](a: A, s: Streaming[A]): Streaming[A]

    Permalink

    Prepend a value to a stream.

  10. def continually[A](a: A): Streaming[A]

    Permalink

    Continually return a constant value.

  11. def defer[A](s: ⇒ Streaming[A]): Streaming[A]

    Permalink

    Defer stream creation.

    Defer stream creation.

    Given an expression which creates a stream, this method defers that creation, allowing the head (if any) to be lazy.

  12. def empty[A]: Streaming[A]

    Permalink

    Create an empty stream of type A.

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def from(n: Int): Streaming[Int]

    Permalink

    Stream of integers starting at n.

  17. def fromFoldable[F[_], A](fa: F[A])(implicit F: Foldable[F]): Streaming[A]

    Permalink
  18. def fromIterable[A](as: Iterable[A]): Streaming[A]

    Permalink

    Create a stream from an iterable.

    Create a stream from an iterable.

    The stream will be eagerly evaluated.

  19. def fromIteratorUnsafe[A](it: Iterator[A]): Streaming[A]

    Permalink

    Create a stream from an iterator.

    Create a stream from an iterator.

    The stream will be created lazily, to support potentially large (or infinite) iterators. Iterators passed to this method should not be used elsewhere -- doing so will result in problems.

    The use case for this method is code like .fromIterable, which creates an iterator for the express purpose of calling this method.

  20. def fromList[A](as: List[A]): Streaming[A]

    Permalink

    Create a stream from a list.

    Create a stream from a list.

    The stream will be eagerly evaluated.

  21. def fromVector[A](as: Vector[A]): Streaming[A]

    Permalink

    Create a stream from a vector.

    Create a stream from a vector.

    The stream will be eagerly evaluated.

  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. def infinite[A](a: A)(f: (A) ⇒ A): Streaming[A]

    Permalink

    Produce an infinite stream of values given an initial value and a tranformation function.

  25. def interval(start: Int, end: Int): Streaming[Int]

    Permalink

    Provide a stream of integers starting with start and ending with end (i.e.

    Provide a stream of integers starting with start and ending with end (i.e. inclusive).

  26. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  27. def knot[A](f: (Eval[Streaming[A]]) ⇒ Streaming[A], memo: Boolean = false): Streaming[A]

    Permalink

    Create a self-referential stream.

  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. implicit def streamEq[A](implicit arg0: Eq[A]): Eq[Streaming[A]]

    Permalink
    Definition Classes
    StreamingInstances2
  32. implicit val streamInstance: Traverse[Streaming] with MonadCombine[Streaming] with CoflatMap[Streaming]

    Permalink
    Definition Classes
    StreamingInstances
  33. implicit def streamOrder[A](implicit arg0: Order[A]): Order[Streaming[A]]

    Permalink
    Definition Classes
    StreamingInstances
  34. implicit def streamPartialOrder[A](implicit arg0: PartialOrder[A]): PartialOrder[Streaming[A]]

    Permalink
    Definition Classes
    StreamingInstances1
  35. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  36. def thunk[A](f: () ⇒ A): Streaming[A]

    Permalink

    Continually return the result of a thunk.

    Continually return the result of a thunk.

    This method only differs from continually in that the thunk may not be pure. The stream is memoized to ensure that repeated traversals produce the same results.

  37. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  38. def unfold[A](o: Option[A])(f: (A) ⇒ Option[A]): Streaming[A]

    Permalink

    Produce a stream given an "unfolding" function.

    Produce a stream given an "unfolding" function.

    None represents an empty stream. Some(a) reprsents an initial element, and we can compute the tail (if any) via f(a).

  39. def wait[A](ls: Eval[Streaming[A]]): Streaming[A]

    Permalink

    Create a stream from an Eval[Streaming[A]] value.

    Create a stream from an Eval[Streaming[A]] value.

    Given an expression which creates a stream, this method defers that creation, allowing the head (if any) to be lazy.

  40. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from StreamingInstances

Inherited from StreamingInstances1

Inherited from StreamingInstances2

Inherited from AnyRef

Inherited from Any

Ungrouped