trait DequeueSource[F[_], A] extends QueueSource[F, A]

Source
Dequeue.scala
Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DequeueSource
  2. QueueSource
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def size: F[Int]
    Definition Classes
    QueueSource
  2. abstract def takeBack: F[A]

    Dequeues an element from the back of the dequeue, possibly fiber blocking until an element becomes available.

  3. abstract def takeFront: F[A]

    Dequeues an element from the front of the dequeue, possibly semantically blocking until an element becomes available.

  4. abstract def tryTakeBack: F[Option[A]]

    Attempts to dequeue an element from the back of the dequeue, if one is available without fiber blocking.

    Attempts to dequeue an element from the back of the dequeue, if one is available without fiber blocking.

    returns

    an effect that describes whether the dequeueing of an element from the dequeue succeeded without blocking, with None denoting that no element was available

  5. abstract def tryTakeFront: F[Option[A]]

    Attempts to dequeue an element from the front of the dequeue, if one is available without fiber blocking.

    Attempts to dequeue an element from the front of the dequeue, if one is available without fiber blocking.

    returns

    an effect that describes whether the dequeueing of an element from the dequeue succeeded without blocking, with None denoting that no element was available

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(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def take: F[A]

    Alias for takeFront in order to implement Queue

    Alias for takeFront in order to implement Queue

    Definition Classes
    DequeueSourceQueueSource
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def tryTake: F[Option[A]]

    Alias for tryTakeFront in order to implement Queue

    Alias for tryTakeFront in order to implement Queue

    returns

    an effect that describes whether the dequeueing of an element from the queue succeeded without blocking, with None denoting that no element was available

    Definition Classes
    DequeueSourceQueueSource
  19. def tryTakeBackN(maxN: Option[Int])(implicit F: Monad[F]): F[List[A]]

    Attempts to dequeue elements from the back of the dequeue, if they available without semantically blocking.

    Attempts to dequeue elements from the back of the dequeue, if they available without semantically blocking. This is a convenience method that recursively runs tryTakeBack. It does not provide any additional performance benefits.

    maxN

    The max elements to dequeue. Passing None will try to dequeue the whole queue.

    returns

    an effect that contains the dequeued elements

  20. def tryTakeFrontN(maxN: Option[Int])(implicit F: Monad[F]): F[List[A]]

    Attempts to dequeue elements from the front of the dequeue, if they available without semantically blocking.

    Attempts to dequeue elements from the front of the dequeue, if they available without semantically blocking. This is a convenience method that recursively runs tryTakeFront. It does not provide any additional performance benefits.

    maxN

    The max elements to dequeue. Passing None will try to dequeue the whole queue.

    returns

    an effect that contains the dequeued elements

  21. def tryTakeN(maxN: Option[Int])(implicit F: Monad[F]): F[List[A]]

    Attempts to dequeue elements from the front of the queue, if they are available without semantically blocking.

    Attempts to dequeue elements from the front of the queue, if they are available without semantically blocking. This method does not guarantee any additional performance benefits beyond simply recursively calling tryTake, though some implementations will provide a more efficient implementation.

    maxN

    The max elements to dequeue. Passing None will try to dequeue the whole queue.

    returns

    an effect that contains the dequeued elements

    Definition Classes
    QueueSource
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from QueueSource[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped