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]
- Source
- Queue.scala
- Alphabetic
- By Inheritance
- Queue
- Dequeue
- DequeueChunk1
- Dequeue1
- Enqueue
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
dequeue1: F[A]
Dequeues one
Afrom this queue.Dequeues one
Afrom this queue. Completes once one is ready.- Definition Classes
- Dequeue1
-
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
-
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
-
abstract
def
dequeueChunk1(maxSize: Int): F[Id[Chunk[A]]]
Dequeues one
Chunk[A]with no more thanmaxSizeelements.Dequeues one
Chunk[A]with no more thanmaxSizeelements. Completes once one is ready.- Definition Classes
- DequeueChunk1
-
abstract
def
enqueue1(a: A): F[Unit]
Enqueues one element to this
Queue.Enqueues one element to this
Queue. If the queue isfullthis waits until queue has space.This completes after
ahas been successfully enqueued to thisQueue- Definition Classes
- Enqueue
-
abstract
def
offer1(a: A): F[Boolean]
Offers one element to this
Queue.Offers one element to this
Queue.Evaluates to
falseif the queue is full, indicating theawas not queued up. Evaluates totrueif theawas queued up successfully.- a
Ato enqueue
- Definition Classes
- Enqueue
-
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,Noneis returned immediately.- Definition Classes
- Dequeue1
-
abstract
def
tryDequeueChunk1(maxSize: Int): F[Option[Id[Chunk[A]]]]
Tries to dequeue a single chunk of no more than
max sizeelements.Tries to dequeue a single chunk of no more than
max sizeelements. UnlikedequeueChunk1, this method does not semantically block until a chunk is available - instead,Noneis returned immediately.- Definition Classes
- DequeueChunk1
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Queue[F, A], B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
dequeue: Stream[F, A]
Dequeues elements from the queue.
Dequeues elements from the queue.
- Definition Classes
- Dequeue
-
def
enqueue: Pipe[F, A, Unit]
Enqueues each element of the input stream to this queue by calling
enqueue1on each element.Enqueues each element of the input stream to this queue by calling
enqueue1on each element.- Definition Classes
- Enqueue
- def ensuring(cond: (Queue[F, A]) ⇒ Boolean, msg: ⇒ Any): Queue[F, A]
- def ensuring(cond: (Queue[F, A]) ⇒ Boolean): Queue[F, A]
- def ensuring(cond: Boolean, msg: ⇒ Any): Queue[F, A]
- def ensuring(cond: Boolean): Queue[F, A]
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
imap[B](f: (A) ⇒ B)(g: (B) ⇒ A)(implicit F: Functor[F]): Queue[F, B]
Returns an alternate view of this
Queuewhere its elements are of typeB, given two functions,A => BandB => A. -
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
- def →[B](y: B): (Queue[F, A], B)