<A, E, R>(self: Stream<A, E, R>): Effect.Effect<
Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>,
never,
R | Scope.Scope
>Returns a scoped pull for manually consuming the stream's output chunks.
Details
The pull fails with Cause.Done when the stream ends and with the stream
error on failure.
Example (Creating a scoped pull)
import { Console, Effect, Stream } from "effect"
const stream = Stream.make(1, 2, 3)
const program = Effect.scoped(
Effect.gen(function*() {
const pull = yield* Stream.toPull(stream)
const chunk = yield* pull
yield* Console.log(chunk)
})
)
Effect.runPromise(program)
// [1, 2, 3]destructors
Source effect/Stream.ts:110373 lines
export const const toPull: <A, E, R>(
self: Stream<A, E, R>
) => Effect.Effect<
Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>,
never,
R | Scope.Scope
>
Returns a scoped pull for manually consuming the stream's output chunks.
Details
The pull fails with Cause.Done when the stream ends and with the stream
error on failure.
Example (Creating a scoped pull)
import { Console, Effect, Stream } from "effect"
const stream = Stream.make(1, 2, 3)
const program = Effect.scoped(
Effect.gen(function*() {
const pull = yield* Stream.toPull(stream)
const chunk = yield* pull
yield* Console.log(chunk)
})
)
Effect.runPromise(program)
// [1, 2, 3]
toPull = <function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>R>(
self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
interface Stream<out A, out E = never, out R = never>A Stream<A, E, R> describes a program that can emit many A values, fail
with E, and require R.
Details
Streams are pull-based with backpressure and emit chunks to amortize effect
evaluation. They support monadic composition and error handling similar to
Effect, adapted for multiple values.
Example (Creating and consuming streams)
import { Console, Effect, Stream } from "effect"
const program = Effect.gen(function*() {
yield* Stream.make(1, 2, 3).pipe(
Stream.map((n) => n * 2),
Stream.runForEach((n) => Console.log(n))
)
})
Effect.runPromise(program)
// Output:
// 2
// 4
// 6
Stream<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>A, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>E, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>R>
): import EffectEffect.type Effect.Effect = /*unresolved*/ anyEffect<import PullPull.type Pull.Pull = /*unresolved*/ anyPull<import ArrArr.type Arr.NonEmptyReadonlyArray = /*unresolved*/ anyNonEmptyReadonlyArray<function (type parameter) A in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>A>, function (type parameter) E in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>E>, never, function (type parameter) R in <A, E, R>(self: Stream<A, E, R>): Effect.Effect<Pull.Pull<Arr.NonEmptyReadonlyArray<A>, E>, never, R | Scope.Scope>R | import ScopeScope.type Scope.Scope = /*unresolved*/ anyScope> => import ChannelChannel.toPull(self: Stream<A, E, R>(parameter) self: {
channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>;
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}
Stream<out A, out E = never, out R = never>.channel: Channel.Channel<Arr.NonEmptyReadonlyArray<A>, E, void, unknown, unknown, unknown, R>(property) Stream<out A, out E = never, out R = never>.channel: {
pipe: { <A>(this: A): A; <A, B = never>(this: A, ab: (_: A) => B): B; <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C; <A, B = never, C = never, D = never>(this: A, ab: (_: A) => B, bc: (_: B) => C, cd: (_: C) => D): D; <…;
}