Trait/Object

fs2.concurrent

InspectableQueue

Related Docs: object InspectableQueue | package concurrent

Permalink

trait InspectableQueue[F[_], A] extends Queue[F, A]

Extension of Queue that allows peeking and inspection of the current size.

Source
Queue.scala
Linear Supertypes
Queue[F, A], Dequeue[F, A], DequeueChunk1[F, Id, A], Dequeue1[F, A], Enqueue[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. InspectableQueue
  2. Queue
  3. Dequeue
  4. DequeueChunk1
  5. Dequeue1
  6. Enqueue
  7. AnyRef
  8. 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[A]

    Permalink

    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]

    Permalink

    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]

    Permalink

    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]]]

    Permalink

    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]

    Permalink

    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 getSize: F[Int]

    Permalink

    Gets the current size of the queue.

  7. abstract def offer1(a: A): F[Boolean]

    Permalink

    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
  8. abstract def peek1: F[A]

    Permalink

    Returns the element which would be dequeued next, but without removing it.

    Returns the element which would be dequeued next, but without removing it. Completes when such an element is available.

  9. abstract def size: Stream[F, Int]

    Permalink

    The time-varying size of this Queue.

    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.

  10. abstract def tryDequeue1: F[Option[A]]

    Permalink

    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
  11. abstract def tryDequeueChunk1(maxSize: Int): F[Option[Id[Chunk[A]]]]

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to any2stringadd[InspectableQueue[F, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (InspectableQueue[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to ArrowAssoc[InspectableQueue[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def dequeue: Stream[F, A]

    Permalink

    Dequeues elements from the queue.

    Dequeues elements from the queue.

    Definition Classes
    Dequeue
  9. def enqueue: Sink[F, A]

    Permalink

    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: (InspectableQueue[F, A]) ⇒ Boolean, msg: ⇒ Any): InspectableQueue[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to Ensuring[InspectableQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (InspectableQueue[F, A]) ⇒ Boolean): InspectableQueue[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to Ensuring[InspectableQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): InspectableQueue[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to Ensuring[InspectableQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): InspectableQueue[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to Ensuring[InspectableQueue[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  16. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to StringFormat[InspectableQueue[F, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  19. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A)(implicit F: Functor[F]): Queue[F, B]

    Permalink

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

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

    Definition Classes
    Queue
  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. def [B](y: B): (InspectableQueue[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from InspectableQueue[F, A] to ArrowAssoc[InspectableQueue[F, A]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @Deprecated @deprecated @throws( classOf[java.lang.Throwable] )
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from Queue[F, A]

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

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

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

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

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

Ungrouped