<A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>Takes and returns all currently buffered messages without waiting for more.
Details
Returns an empty array when the queue is empty or has completed normally. If the queue has failed, the effect fails with the queue's error.
Example (Clearing queued values)
import { Cause, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number>(10)
// Add several messages
yield* Queue.offerAll(queue, [1, 2, 3, 4, 5])
// Clear all messages from the queue
const messages = yield* Queue.clear(queue)
console.log(messages) // [1, 2, 3, 4, 5]
// Queue is now empty
const size = yield* Queue.size(queue)
console.log(size) // 0
// Clearing empty queue returns empty array
const empty = yield* Queue.clear(queue)
console.log(empty) // []
})taking
Source effect/Queue.ts:117112 lines
export const const clear: <A, E>(
self: Dequeue<A, E>
) => Effect<Array<A>, Pull.ExcludeDone<E>>
Takes and returns all currently buffered messages without waiting for more.
Details
Returns an empty array when the queue is empty or has completed normally. If
the queue has failed, the effect fails with the queue's error.
Example (Clearing queued values)
import { Cause, Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number>(10)
// Add several messages
yield* Queue.offerAll(queue, [1, 2, 3, 4, 5])
// Clear all messages from the queue
const messages = yield* Queue.clear(queue)
console.log(messages) // [1, 2, 3, 4, 5]
// Queue is now empty
const size = yield* Queue.size(queue)
console.log(size) // 0
// Clearing empty queue returns empty array
const empty = yield* Queue.clear(queue)
console.log(empty) // []
})
clear = <function (type parameter) A in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>A, function (type parameter) E in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>E>(self: Dequeue<A, E>(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 Dequeue<out A, out E = never>A Dequeue is a queue that can be taken from.
Details
This interface represents the read-only part of a Queue, allowing you to take
elements from the queue but not offer elements to it.
Example (Taking through dequeue handles)
import { Effect, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<string, never>(10)
// A Dequeue can only take elements
const dequeue: Queue.Dequeue<string> = queue
// Pre-populate the queue
yield* Queue.offerAll(queue, ["a", "b", "c"])
// Take elements using dequeue interface
const item = yield* Queue.take(dequeue)
console.log(item) // "a"
})
Companion namespace containing type-level metadata for the Dequeue
read-only queue interface.
Dequeue<function (type parameter) A in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>A, function (type parameter) E in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>E>): import EffectEffect<interface Array<T>Array<function (type parameter) A in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>A>, import PullPull.type Pull.ExcludeDone = /*unresolved*/ anyExcludeDone<function (type parameter) E in <A, E>(self: Dequeue<A, E>): Effect<Array<A>, Pull.ExcludeDone<E>>E>> =>
import internalEffectinternalEffect.const suspend: <A, E, R>(
evaluate: LazyArg<Effect.Effect<A, E, R>>
) => Effect.Effect<A, E, R>
self: Dequeue<A, E>(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;
}
Dequeue<out A, out E = never>.state: Queue.State<any, any>state._tag: "Open" | "Closing" | "Done"_tag === "Done") {
if (import PullPull.isDoneCause(self: Dequeue<A, E>(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;
}
Dequeue<out A, out E = never>.state: {
readonly _tag: "Done";
readonly exit: Failure<never, E>;
}
exit: Failure<never, E>(property) exit: {
_tag: "Failure";
cause: Cause.Cause<E>;
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; <…;
toString: () => string;
toJSON: () => unknown;
}
import internalEffectinternalEffect.const succeed: <A>(
value: A
) => Effect.Effect<A>
self: Dequeue<A, E>(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;
}
Dequeue<out A, out E = never>.state: {
readonly _tag: "Done";
readonly exit: Failure<never, E>;
}
exit: Failure<never, E>(property) exit: {
_tag: "Failure";
cause: Cause.Cause<E>;
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; <…;
toString: () => string;
toJSON: () => unknown;
}
const messages: anymessages = const takeAllUnsafe: <A, E>(
self: Dequeue<A, E>
) => Array<any>
self: Dequeue<A, E>(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;
}
const releaseCapacity: <A, E>(
self: Dequeue<A, E>
) => boolean
self: Dequeue<A, E>(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 internalEffectinternalEffect.const succeed: <A>(
value: A
) => Effect.Effect<A>
const messages: anymessages)
})