fs2-core/fs2.concurrent/InspectableQueue

InspectableQueue

@deprecated("Use cats.effect.std.Queue instead", "3.0.0") trait InspectableQueue[F <: ([_$46] =>> Any), A] extends Queue[F, A]
Extension of Queue that allows peeking and inspection of the current size.
Companion
object
trait Queue[F, A]
trait Dequeue[F, A]
trait DequeueChunk1[F, Id, A]
trait Dequeue1[F, A]
trait Enqueue[F, A]
class Object
trait Matchable
class Any

Value members

Methods

def peek1: F[A]
Returns the element which would be dequeued next,
but without removing it. Completes when such an
element is available.
def size: Stream[F, Int]
The time-varying size of this Queue.
Emits elements describing the current size of the queue.
Offsetting enqueues and de-queues may not result in refreshes.
Finally, note that operations like dequeue are optimized to
work on chunks when possible, which will result in faster
decreases in size that one might expect.
More granular updates can be achieved by calling dequeue1
repeatedly, but this is less efficient than dequeueing in
batches.
def getSize: F[Int]
Gets the current size of the queue.

Inherited methods

def dequeueChunk1(maxSize: Int): F[G[Chunk[A]]]
Dequeues one Chunk[A] with no more than maxSize elements. Completes once one is ready.
Inhertied from
DequeueChunk1
def dequeue: Stream[F, A]
Dequeues elements from the queue.
Inhertied from
Dequeue
def enqueue1(a: A): F[Unit]
Enqueues one element to this Queue.
If the queue is full this waits until queue has space.
This completes after a has been successfully enqueued to this Queue
Inhertied from
Enqueue
def offer1(a: A): F[Boolean]
Offers one element to this Queue.
Evaluates to false if the queue is full, indicating the a was not queued up.
Evaluates to true if the a was queued up successfully.
Value Params
a
A to enqueue
Inhertied from
Enqueue
def tryDequeueChunk1(maxSize: Int): F[Option[G[Chunk[A]]]]
Tries to dequeue a single chunk of no more than max size elements.
Unlike dequeueChunk1, this method does not semantically block until a chunk is available -
instead, None is returned immediately.
Inhertied from
DequeueChunk1
def dequeue1: F[A]
Dequeues one A from this queue. Completes once one is ready.
Inhertied from
Dequeue1
def dequeueChunk(maxSize: Int): Stream[F, A]
Dequeues elements from the queue, ensuring elements are dequeued in chunks not exceeding maxSize.
Inhertied from
Dequeue
def enqueue: (F, A) => Unit
Enqueues each element of the input stream to this queue by
calling enqueue1 on each element. Emits a unit for each element enqueued.
Inhertied from
Enqueue
def tryDequeue1: F[Option[A]]
Tries to dequeue a single element. Unlike dequeue1, this method does not semantically
block until a chunk is available - instead, None is returned immediately.
Inhertied from
Dequeue1
def imap[B](f: A => B)(g: B => A)(F: Functor[F]): Queue[F, B]
Returns an alternate view of this Queue where its elements are of type B,
given two functions, A => B and B => A.
Inhertied from
Queue
def dequeueBatch: (F, Int) => A
Provides a pipe that converts a stream of batch sizes in to a stream of elements by dequeuing
batches of the specified size.
Inhertied from
Dequeue