PQueueSink

cats.effect.std.PQueueSink
See thePQueueSink companion object
trait PQueueSink[F[_], A] extends QueueSink[F, A]

Attributes

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

Members list

Value members

Concrete methods

override def tryOfferN(list: List[A])(implicit F: Monad[F]): F[List[A]]

Attempts to enqueue the given elements without semantically blocking.

Attempts to enqueue the given elements without semantically blocking. If an item in the list cannot be enqueued, the remaining elements will be returned. This is a convenience method that recursively runs tryOffer and does not offer any additional performance benefits.

Value parameters

list

the elements to be put in the PQueue

Attributes

Returns

an effect that contains the remaining valus that could not be offered.

Definition Classes
Source
PQueue.scala

Inherited methods

def offer(a: A): F[Unit]

Enqueues the given element at the back of the queue, possibly fiber blocking until sufficient capacity becomes available.

Enqueues the given element at the back of the queue, possibly fiber blocking until sufficient capacity becomes available.

Value parameters

a

the element to be put at the back of the queue

Attributes

Inherited from:
QueueSink
Source
QueueSink.scala
def tryOffer(a: A): F[Boolean]

Attempts to enqueue the given element at the back of the queue without semantically blocking.

Attempts to enqueue the given element at the back of the queue without semantically blocking.

Value parameters

a

the element to be put at the back of the queue

Attributes

Returns

an effect that describes whether the enqueuing of the given element succeeded without blocking

Inherited from:
QueueSink
Source
QueueSink.scala