<A, E>(self: Enqueue<A, E | Done>): Effect<boolean>Signals queue completion.
When to use
Use to stop accepting new offers while allowing already queued messages to be consumed.
Details
Returns false if the queue is already done.
Example (Ending queues)
import { Cause, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(10)
// Add some messages
yield* Queue.offer(queue, 1)
yield* Queue.offer(queue, 2)
// Signal completion - no more messages will be accepted
const ended = yield* Queue.end(queue)
console.log(ended) // true
// Trying to offer more messages will return false
const offerResult = yield* Queue.offer(queue, 3)
console.log(offerResult) // false
// But we can still take existing messages
const message = yield* Queue.take(queue)
console.log(message) // 1
})completion
Source effect/Queue.ts:9821 lines
export const const end: <A, E>(
self: Enqueue<A, E | Done>
) => Effect<boolean>
Signals queue completion.
When to use
Use to stop accepting new offers while allowing already queued messages to be
consumed.
Details
Returns false if the queue is already done.
Example (Ending queues)
import { Cause, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(10)
// Add some messages
yield* Queue.offer(queue, 1)
yield* Queue.offer(queue, 2)
// Signal completion - no more messages will be accepted
const ended = yield* Queue.end(queue)
console.log(ended) // true
// Trying to offer more messages will return false
const offerResult = yield* Queue.offer(queue, 3)
console.log(offerResult) // false
// But we can still take existing messages
const message = yield* Queue.take(queue)
console.log(message) // 1
})
end = <function (type parameter) A in <A, E>(self: Enqueue<A, E | Done>): Effect<boolean>A, function (type parameter) E in <A, E>(self: Enqueue<A, E | Done>): Effect<boolean>E>(self: Enqueue<A, E | Done>(parameter) self: {
strategy: "suspend" | "dropping" | "sliding";
dispatcher: SchedulerDispatcher;
capacity: number;
messages: MutableList.MutableList<any>;
state: Queue.State<any, any>;
scheduleRunning: boolean;
toString: () => string;
toJSON: () => unknown;
}
interface Enqueue<in A, in E = never>An Enqueue is a queue that can be offered to.
Details
This interface represents the write-only part of a Queue, allowing you to offer
elements to the queue but not take elements from it.
Example (Offering through enqueue handles)
import { Effect, Queue } from "effect"
// Function that only needs write access to a queue
const producer = (enqueue: Queue.Enqueue<string>) =>
Effect.gen(function*() {
yield* Queue.offer(enqueue, "hello")
yield* Queue.offerAll(enqueue, ["world", "!"])
})
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<string>(10)
yield* producer(queue)
})
Companion namespace containing type-level metadata for the Enqueue
write-only queue interface.
Enqueue<function (type parameter) A in <A, E>(self: Enqueue<A, E | Done>): Effect<boolean>A, function (type parameter) E in <A, E>(self: Enqueue<A, E | Done>): Effect<boolean>E | import DoneDone>): import EffectEffect<boolean> => const failCause: {
<E>(cause: Cause<E>): <A>(
self: Enqueue<A, E>
) => Effect<boolean>
<A, E>(
self: Enqueue<A, E>,
cause: Cause<E>
): Effect<boolean>
}
self: Enqueue<A, E | Done>(parameter) self: {
strategy: "suspend" | "dropping" | "sliding";
dispatcher: SchedulerDispatcher;
capacity: number;
messages: MutableList.MutableList<any>;
state: Queue.State<any, any>;
scheduleRunning: boolean;
toString: () => string;
toJSON: () => unknown;
}
import corecore.const causeFail: <E>(
error: E
) => Cause.Cause<E>
import corecore.const Done: <A = void>(
value?: A
) => Cause.Done<A>
Referenced by 1 symbols