Packages

trait Queue[F[_], A] extends Enqueue[F, A] with Dequeue1[F, A] with DequeueChunk1[F, Id, A] with Dequeue[F, A]

A queue of elements. Operations are all nonblocking in their implementations, but may be 'semantically' blocking. For instance, a queue may have a bound on its size, in which case enqueuing may block (be delayed asynchronously) until there is an offsetting dequeue.

Self Type
Queue[F, A]
Annotations
@deprecated
Deprecated

(Since version 3.0.0) Use cats.effect.std.Queue instead

Source
Queue.scala
Linear Supertypes
Dequeue[F, A], DequeueChunk1[F, Id, A], Dequeue1[F, A], Enqueue[F, A], AnyRef, Any
Known Subclasses
InspectableQueue
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Queue
  2. Dequeue
  3. DequeueChunk1
  4. Dequeue1
  5. Enqueue
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def dequeue1: F[A]

    Dequeues one A from this queue.

    Dequeues one A from this queue. Completes once one is ready.

    Definition Classes
    Dequeue1
  2. abstract def dequeueBatch: Pipe[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.

    Provides a pipe that converts a stream of batch sizes in to a stream of elements by dequeuing batches of the specified size.

    Definition Classes
    Dequeue
  3. abstract def dequeueChunk(maxSize: Int): Stream[F, A]

    Dequeues elements from the queue, ensuring elements are dequeued in chunks not exceeding maxSize.

    Dequeues elements from the queue, ensuring elements are dequeued in chunks not exceeding maxSize.

    Definition Classes
    Dequeue
  4. abstract def dequeueChunk1(maxSize: Int): F[Id[Chunk[A]]]

    Dequeues one Chunk[A] with no more than maxSize elements.

    Dequeues one Chunk[A] with no more than maxSize elements. Completes once one is ready.

    Definition Classes
    DequeueChunk1
  5. abstract def enqueue1(a: A): F[Unit]

    Enqueues one element to this Queue.

    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

    Definition Classes
    Enqueue
  6. abstract def offer1(a: A): F[Boolean]

    Offers one element to this Queue.

    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.

    a

    A to enqueue

    Definition Classes
    Enqueue
  7. abstract def tryDequeue1: F[Option[A]]

    Tries to dequeue a single element.

    Tries to dequeue a single element. Unlike dequeue1, this method does not semantically block until a chunk is available - instead, None is returned immediately.

    Definition Classes
    Dequeue1
  8. abstract def tryDequeueChunk1(maxSize: Int): F[Option[Id[Chunk[A]]]]

    Tries to dequeue a single chunk of no more than max size elements.

    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.

    Definition Classes
    DequeueChunk1

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  6. def dequeue: Stream[F, A]

    Dequeues elements from the queue.

    Dequeues elements from the queue.

    Definition Classes
    Dequeue
  7. def enqueue: Pipe[F, A, Unit]

    Enqueues each element of the input stream to this queue by calling enqueue1 on each element.

    Enqueues each element of the input stream to this queue by calling enqueue1 on each element. Emits a unit for each element enqueued.

    Definition Classes
    Enqueue
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A)(implicit 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.

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Dequeue[F, A]

Inherited from DequeueChunk1[F, Id, A]

Inherited from Dequeue1[F, A]

Inherited from Enqueue[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped