Scala 3
3.8.0-RC1-bin-20250819-1f13619-NIGHTLY
LearnInstallPlaygroundFind A LibraryCommunityBlog
LearnInstallPlaygroundFind A LibraryCommunityBlog
DocsAPI
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL
Scala 3/scala/scala.collection/scala.collection.immutable/Stream

Stream

scala.collection.immutable.Stream
See theStream companion class
object Stream extends SeqFactory[Stream]

Attributes

Companion
class
Deprecated
[Since version 2.13.0] Use LazyList (which is fully lazy) instead of Stream (which has a lazy tail only)
Source
Stream.scala
Graph
Supertypes
trait Pure
trait Serializable
class Object
trait Matchable
class Any
Show all
Self type
Stream.type

Members list

Type members

Classlikes

object #::

Attributes

Source
Stream.scala
Supertypes
class Object
trait Matchable
class Any
Self type
#::.type
final class Cons[A](val head: A, tl: => Stream[A]) extends Stream[A]

Attributes

Source
Stream.scala
Supertypes
class Stream[A]
trait Serializable
trait LinearSeq[A]
trait LinearSeqOps[A, Stream, Stream[A]]
trait LinearSeq[A]
trait LinearSeqOps[A, Stream, Stream[A]]
class AbstractSeq[A]
trait Seq[A]
trait SeqOps[A, Stream, Stream[A]]
trait Iterable[A]
class AbstractSeq[A]
trait Seq[A]
trait Pure
trait Equals
trait SeqOps[A, Stream, Stream[A]]
trait PartialFunction[Int, A]
trait Int => A
class AbstractIterable[A]
trait Iterable[A]
trait IterableOps[A, Stream, Stream[A]]
trait IterableOnceOps[A, Stream, Stream[A]]
trait IterableOnce[A]
class Object
trait Matchable
class Any
Show all
final class Deferrer[A] extends AnyVal

Attributes

Source
Stream.scala
Supertypes
class AnyVal
trait Matchable
class Any
object Empty extends Stream[Nothing]

Attributes

Source
Stream.scala
Supertypes
class Stream[Nothing]
trait Serializable
trait Seq[Nothing]
trait Iterable[Nothing]
trait Seq[Nothing]
trait Pure
trait Equals
trait Int => Nothing
trait Iterable[Nothing]
class Object
trait Matchable
class Any
Show all
Self type
Empty.type
class SerializationProxy[A](var coll: Stream[A]) extends Serializable

This serialization proxy is used for Streams which start with a sequence of evaluated cons cells.

This serialization proxy is used for Streams which start with a sequence of evaluated cons cells. The forced sequence is serialized in a compact, sequential format, followed by the unevaluated tail, which uses standard Java serialization to store the complete structure of unevaluated thunks. This allows the serialization of long evaluated streams without exhausting the stack through recursive serialization of cons cells.

Attributes

Source
Stream.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object cons

An alternative way of building and matching Streams using Stream.cons(hd, tl).

An alternative way of building and matching Streams using Stream.cons(hd, tl).

Attributes

Source
Stream.scala
Supertypes
class Object
trait Matchable
class Any
Self type
cons.type

Value members

Concrete methods

def continually[A](elem: => A): Stream[A]

Create an infinite Stream containing the given element expression (which is computed for each occurrence).

Create an infinite Stream containing the given element expression (which is computed for each occurrence).

Value parameters

elem

the element composing the resulting Stream

Attributes

Returns

the Stream containing an infinite number of elem

Source
Stream.scala
def empty[A]: Stream[A]

An empty collection

An empty collection

Type parameters

A

the type of the collection's elements

Attributes

Source
Stream.scala
def from[A](coll: IterableOnce[A]): Stream[A]

Creates a target collection from an existing source collection

Creates a target collection from an existing source collection

Type parameters

A

the type of the collection’s elements

Value parameters

source

Source collection

Attributes

Returns

a new collection with the elements of source

Source
Stream.scala
def from(start: Int, step: Int): Stream[Int]

Create an infinite Stream starting at start and incrementing by step step.

Create an infinite Stream starting at start and incrementing by step step.

Value parameters

start

the start value of the Stream

step

the increment value of the Stream

Attributes

Returns

the Stream starting at value start.

Source
Stream.scala
def from(start: Int): Stream[Int]

Create an infinite Stream starting at start and incrementing by 1.

Create an infinite Stream starting at start and incrementing by 1.

Value parameters

start

the start value of the Stream

Attributes

Returns

the Stream starting at value start.

Source
Stream.scala
def fromIterator[A](it: Iterator[A]): Stream[A]

Type parameters

A

type of elements

Value parameters

it

Source iterator

Attributes

Returns

A Stream[A] that gets its elements from the given Iterator.

Source
Stream.scala
def iterate[A](start: A)(f: A => A): Stream[A]

An infinite Stream that repeatedly applies a given function to a start value.

An infinite Stream that repeatedly applies a given function to a start value.

Value parameters

f

the function that's repeatedly applied

start

the start value of the Stream

Attributes

Returns

the Stream returning the infinite sequence of values start, f(start), f(f(start)), ...

Source
Stream.scala
override def newBuilder[A]: Builder[A, Stream[A]]

Type parameters

A

the type of the collection’s elements

Attributes

Returns

A builder for Iterable objects.

Definition Classes
Source
Stream.scala

Inherited methods

def apply[A](elems: A*): Stream[A]

Creates a collection with the specified elements.

Creates a collection with the specified elements.

Type parameters

A

the type of the collection's elements

Value parameters

elems

the elements of the created collection

Attributes

Returns

a new collection with elements elems

Inherited from:
IterableFactory
Source
Factory.scala
def concat[A](xss: Iterable[A]*): Stream[A]

Concatenates all argument collections into a single collection.

Concatenates all argument collections into a single collection.

Value parameters

xss

the collections that are to be concatenated.

Attributes

Returns

the concatenation of all the collections.

Inherited from:
IterableFactory
Source
Factory.scala
def fill[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(elem: => A): Stream[Stream[Stream[Stream[Stream[A]]]]]

Produces a five-dimensional collection containing the results of some element computation a number of times.

Produces a five-dimensional collection containing the results of some element computation a number of times.

Value parameters

elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

n5

the number of elements in the 5th dimension

Attributes

Returns

A collection that contains the results of n1 x n2 x n3 x n4 x n5 evaluations of elem.

Inherited from:
IterableFactory
Source
Factory.scala
def fill[A](n1: Int, n2: Int, n3: Int, n4: Int)(elem: => A): Stream[Stream[Stream[Stream[A]]]]

Produces a four-dimensional collection containing the results of some element computation a number of times.

Produces a four-dimensional collection containing the results of some element computation a number of times.

Value parameters

elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

Attributes

Returns

A collection that contains the results of n1 x n2 x n3 x n4 evaluations of elem.

Inherited from:
IterableFactory
Source
Factory.scala
def fill[A](n1: Int, n2: Int, n3: Int)(elem: => A): Stream[Stream[Stream[A]]]

Produces a three-dimensional collection containing the results of some element computation a number of times.

Produces a three-dimensional collection containing the results of some element computation a number of times.

Value parameters

elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

Attributes

Returns

A collection that contains the results of n1 x n2 x n3 evaluations of elem.

Inherited from:
IterableFactory
Source
Factory.scala
def fill[A](n1: Int, n2: Int)(elem: => A): Stream[Stream[A]]

Produces a two-dimensional collection containing the results of some element computation a number of times.

Produces a two-dimensional collection containing the results of some element computation a number of times.

Value parameters

elem

the element computation

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

Attributes

Returns

A collection that contains the results of n1 x n2 evaluations of elem.

Inherited from:
IterableFactory
Source
Factory.scala
def fill[A](n: Int)(elem: => A): Stream[A]

Produces a collection containing the results of some element computation a number of times.

Produces a collection containing the results of some element computation a number of times.

Value parameters

elem

the element computation

n

the number of elements contained in the collection.

Attributes

Returns

A collection that contains the results of n evaluations of elem.

Inherited from:
IterableFactory
Source
Factory.scala
def iterate[A](start: A, len: Int)(f: A => A): Stream[A]

Produces a collection containing repeated applications of a function to a start value.

Produces a collection containing repeated applications of a function to a start value.

Value parameters

f

the function that's repeatedly applied

len

the number of elements contained in the collection

start

the start value of the collection

Attributes

Returns

a collection with len values in the sequence start, f(start), f(f(start)), ...

Inherited from:
IterableFactory
Source
Factory.scala
def range[A : Integral](start: A, end: A, step: A): Stream[A]

Produces a collection containing equally spaced values in some integer interval.

Produces a collection containing equally spaced values in some integer interval.

Value parameters

end

the end value of the collection (the first value NOT contained)

start

the start value of the collection

step

the difference between successive elements of the collection (must be positive or negative)

Attributes

Returns

a collection with values start, start + step, ... up to, but excluding end

Inherited from:
IterableFactory
Source
Factory.scala
def range[A : Integral](start: A, end: A): Stream[A]

Produces a collection containing a sequence of increasing of integers.

Produces a collection containing a sequence of increasing of integers.

Value parameters

end

the end value of the collection (the first value NOT contained)

start

the first element of the collection

Attributes

Returns

a collection with values start, start + 1, ..., end - 1

Inherited from:
IterableFactory
Source
Factory.scala
def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int, n5: Int)(f: (Int, Int, Int, Int, Int) => A): Stream[Stream[Stream[Stream[Stream[A]]]]]

Produces a five-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a five-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value parameters

f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

n5

the number of elements in the 5th dimension

Attributes

Returns

A collection consisting of elements f(i1, i2, i3, i4, i5) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, 0 <= i4 < n4, and 0 <= i5 < n5.

Inherited from:
IterableFactory
Source
Factory.scala
def tabulate[A](n1: Int, n2: Int, n3: Int, n4: Int)(f: (Int, Int, Int, Int) => A): Stream[Stream[Stream[Stream[A]]]]

Produces a four-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a four-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value parameters

f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

n4

the number of elements in the 4th dimension

Attributes

Returns

A collection consisting of elements f(i1, i2, i3, i4) for 0 <= i1 < n1, 0 <= i2 < n2, 0 <= i3 < n3, and 0 <= i4 < n4.

Inherited from:
IterableFactory
Source
Factory.scala
def tabulate[A](n1: Int, n2: Int, n3: Int)(f: (Int, Int, Int) => A): Stream[Stream[Stream[A]]]

Produces a three-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a three-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value parameters

f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

n3

the number of elements in the 3rd dimension

Attributes

Returns

A collection consisting of elements f(i1, i2, i3) for 0 <= i1 < n1, 0 <= i2 < n2, and 0 <= i3 < n3.

Inherited from:
IterableFactory
Source
Factory.scala
def tabulate[A](n1: Int, n2: Int)(f: (Int, Int) => A): Stream[Stream[A]]

Produces a two-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Produces a two-dimensional collection containing values of a given function over ranges of integer values starting from 0.

Value parameters

f

The function computing element values

n1

the number of elements in the 1st dimension

n2

the number of elements in the 2nd dimension

Attributes

Returns

A collection consisting of elements f(i1, i2) for 0 <= i1 < n1 and 0 <= i2 < n2.

Inherited from:
IterableFactory
Source
Factory.scala
def tabulate[A](n: Int)(f: Int => A): Stream[A]

Produces a collection containing values of a given function over a range of integer values starting from 0.

Produces a collection containing values of a given function over a range of integer values starting from 0.

Value parameters

f

The function computing element values

n

The number of elements in the collection

Attributes

Returns

A collection consisting of elements f(0), ..., f(n -1)

Inherited from:
IterableFactory
Source
Factory.scala
final def unapplySeq[A](x: Stream[A]): UnapplySeqWrapper[A]

Attributes

Inherited from:
SeqFactory
Source
Factory.scala
def unfold[A, S](init: S)(f: S => Option[(A, S)]): Stream[A]

Produces a collection that uses a function f to produce elements of type A and update an internal state of type S.

Produces a collection that uses a function f to produce elements of type A and update an internal state of type S.

Type parameters

A

Type of the elements

S

Type of the internal state

Value parameters

f

Computes the next element (or returns None to signal the end of the collection)

init

State initial value

Attributes

Returns

a collection that produces elements using f until f returns None

Inherited from:
IterableFactory
Source
Factory.scala

Implicits

Implicits

implicit def toDeferrer[A](l: => Stream[A]): Deferrer[A]

Attributes

Source
Stream.scala

Inherited implicits

implicit def iterableFactory[A]: Factory[A, Stream[A]]

Attributes

Inherited from:
IterableFactory
Source
Factory.scala
Generated with
Copyright (c) 2002-2025, LAMP/EPFL
Copyright (c) 2002-2025, LAMP/EPFL