Packages

t

fs2.concurrent

NoneTerminatedQueue

trait NoneTerminatedQueue[F[_], A] extends Enqueue[F, Option[A]] with Dequeue1[F, Option[A]] with DequeueChunk1[F, Option, A] with Dequeue[F, A]

Like Queue, but allows allows signalling of no further enqueues by enqueueing None. Optimizes dequeue to minimum possible boxing.

Self Type
NoneTerminatedQueue[F, A]
Source
Queue.scala
Linear Supertypes
Dequeue[F, A], DequeueChunk1[F, Option, A], Dequeue1[F, Option[A]], Enqueue[F, Option[A]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. NoneTerminatedQueue
  2. Dequeue
  3. DequeueChunk1
  4. Dequeue1
  5. Enqueue
  6. AnyRef
  7. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def dequeue1: F[Option[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[Option[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: Option[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: Option[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[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[Option[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. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to any2stringadd[NoneTerminatedQueue[F, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (NoneTerminatedQueue[F, A], B)
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to ArrowAssoc[NoneTerminatedQueue[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. def dequeue: Stream[F, A]

    Dequeues elements from the queue.

    Dequeues elements from the queue.

    Definition Classes
    Dequeue
  9. def enqueue: Pipe[F, Option[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.

    Definition Classes
    Enqueue
  10. def ensuring(cond: (NoneTerminatedQueue[F, A]) ⇒ Boolean, msg: ⇒ Any): NoneTerminatedQueue[F, A]
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to Ensuring[NoneTerminatedQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (NoneTerminatedQueue[F, A]) ⇒ Boolean): NoneTerminatedQueue[F, A]
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to Ensuring[NoneTerminatedQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): NoneTerminatedQueue[F, A]
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to Ensuring[NoneTerminatedQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): NoneTerminatedQueue[F, A]
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to Ensuring[NoneTerminatedQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to StringFormat[NoneTerminatedQueue[F, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A)(implicit F: Functor[F]): NoneTerminatedQueue[F, B]

    Returns an alternate view of this NoneTerminatedQueue where its elements are of type B, given two functions, A => B and B => A.

  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  30. def →[B](y: B): (NoneTerminatedQueue[F, A], B)
    Implicit
    This member is added by an implicit conversion from NoneTerminatedQueue[F, A] to ArrowAssoc[NoneTerminatedQueue[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Dequeue[F, A]

Inherited from DequeueChunk1[F, Option, A]

Inherited from Dequeue1[F, Option[A]]

Inherited from Enqueue[F, Option[A]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from NoneTerminatedQueue[F, A] to any2stringadd[NoneTerminatedQueue[F, A]]

Inherited by implicit conversion StringFormat from NoneTerminatedQueue[F, A] to StringFormat[NoneTerminatedQueue[F, A]]

Inherited by implicit conversion Ensuring from NoneTerminatedQueue[F, A] to Ensuring[NoneTerminatedQueue[F, A]]

Inherited by implicit conversion ArrowAssoc from NoneTerminatedQueue[F, A] to ArrowAssoc[NoneTerminatedQueue[F, A]]

Ungrouped