<A, E>(self: Dequeue<A, E>): Effect<boolean>Checks whether the queue is full.
Example (Checking if queues are full)
import { Cause, Effect, Option, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(3)
console.log(yield* Queue.isFull(queue)) // false
// Add some messages
yield* Queue.offerAll(queue, [1, 2, 3])
console.log(yield* Queue.isFull(queue)) // true
})sizes
Source effect/Queue.ts:16551 lines
export const const isFull: <A, E>(
self: Dequeue<A, E>
) => Effect<boolean>
Checks whether the queue is full.
Example (Checking if queues are full)
import { Cause, Effect, Option, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(3)
console.log(yield* Queue.isFull(queue)) // false
// Add some messages
yield* Queue.offerAll(queue, [1, 2, 3])
console.log(yield* Queue.isFull(queue)) // true
})
isFull = <function (type parameter) A in <A, E>(self: Dequeue<A, E>): Effect<boolean>A, function (type parameter) E in <A, E>(self: Dequeue<A, E>): Effect<boolean>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<boolean>A, function (type parameter) E in <A, E>(self: Dequeue<A, E>): Effect<boolean>E>): import EffectEffect<boolean> => import internalEffectinternalEffect.const sync: <A>(
thunk: LazyArg<A>
) => Effect.Effect<A>
const isFullUnsafe: <A, E>(
self: Dequeue<A, E>
) => boolean
Checks whether the queue is full synchronously.
When to use
Use when an immediate Queue capacity snapshot is needed outside effectful
code and racing queue changes are acceptable.
Example (Checking fullness synchronously)
import { Cause, Effect, Option, Queue } from "effect"
const program = Effect.gen(function*() {
const queue = yield* Queue.bounded<number, Cause.Done>(3)
console.log(Queue.isFullUnsafe(queue)) // false
// Add some messages
yield* Queue.offerAll(queue, [1, 2, 3])
console.log(Queue.isFullUnsafe(queue)) // true
})
isFullUnsafe(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;
}