Queue38

Constructors

boundedconstCreates a bounded queue with the specified capacity that uses backpressure strategy.droppingconstCreates a bounded queue with dropping strategy.makeconstCreates a Queue with optional capacity and overflow strategy.slidingconstCreates a bounded queue with sliding strategy.unboundedconstCreates an unbounded queue that can grow to any size without blocking producers.

Models

DequeueinterfaceA Dequeue is a queue that can be taken from.EnqueueinterfaceAn Enqueue is a queue that can be offered to.QueueinterfaceA Queue is an asynchronous queue that can be offered to and taken from.

Guards

isDequeueconstType guard to check if a value is a Dequeue.isEnqueueconstType guard to check if a value is an Enqueue.isQueueconstType guard to check if a value is a Queue.

Completion

endconstSignals queue completion.endUnsafeconstSignals queue completion synchronously.failconstFails the queue with an error.failCauseconstFails the queue with a cause.failCauseUnsafeconstFails the queue with a cause synchronously.interruptconstInterrupts the queue gracefully, transitioning it to a closing state.intoconstRuns an Effect into a Queue, where success ends the queue and failure fails the queue.shutdownconstShuts down the queue immediately, discarding buffered messages and resuming pending operations.

Converting

asDequeueconstNarrows a Queue to a Dequeue, exposing the consumer side of the queue.asEnqueueconstConverts a Queue to its write-only Enqueue interface.

Offering

offerconstAdds a message to the queue.offerAllconstAdds multiple messages to the queue.offerAllUnsafeconstAdds multiple messages to the queue synchronously.offerUnsafeconstAdds a message to the queue synchronously.

Sizes

isFullconstChecks whether the queue is full.isFullUnsafeconstChecks whether the queue is full synchronously.sizeconstReturns the current number of buffered messages in the queue.sizeUnsafeconstReturns the current number of buffered messages in the queue synchronously.

Taking

clearconstTakes and returns all currently buffered messages without waiting for more.collectconstTakes all messages from the queue, until the queue has errored or is done.peekconstPeeks at the next item without removing it.pollconstAttempts to take one item from the queue without waiting.takeconstTakes a single message from the queue, or wait for a message to be available.takeAllconstTakes all currently available messages, waiting until at least one message is available when the queue is empty.takeBetweenconstTakes between min and max messages from the queue.takeNconstTakes up to n messages from the queue.takeUnsafeconstAttempts to take one message from the queue synchronously.