PQueueSource

cats.effect.std.PQueueSource
See thePQueueSource companion object
trait PQueueSource[F[_], A] extends QueueSource[F, A]

Attributes

Companion
object
Source
PQueue.scala
Graph
Supertypes
trait QueueSource[F, A]
class Object
trait Matchable
class Any
Known subtypes
class PQueue[F, A]

Members list

Value members

Concrete methods

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

Attempts to dequeue elements from the PQueue, if they are available without semantically blocking.

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

Value parameters

maxN

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

Attributes

Returns

an effect that contains the dequeued elements from the PQueue Note: If there are multiple elements with least priority, the order in which they are dequeued is undefined.

Definition Classes
Source
PQueue.scala

Inherited methods

def size: F[Int]

Attributes

Inherited from:
QueueSource
Source
QueueSource.scala
def take: F[A]

Dequeues an element from the front of the queue, possibly fiber blocking until an element becomes available.

Dequeues an element from the front of the queue, possibly fiber blocking until an element becomes available.

Attributes

Inherited from:
QueueSource
Source
QueueSource.scala
def tryTake: F[Option[A]]

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

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

Attributes

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

Inherited from:
QueueSource
Source
QueueSource.scala