QueueSink

cats.effect.std.QueueSink
See theQueueSink companion object
trait QueueSink[F[_], A]

Attributes

Companion:
object
Source:
Queue.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait DequeueSink[F, A]
trait Dequeue[F, A]
class Queue[F, A]

Members list

Concise view

Value members

Abstract 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.

Attributes

a

the element to be put at the back of the queue

Source:
Queue.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.

Attributes

a

the element to be put at the back of the queue

Returns:

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

Source:
Queue.scala

Concrete methods

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

Attempts to enqueue the given elements at the back of the queue 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.

Attempts to enqueue the given elements at the back of the queue 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.

Attributes

list

the elements to be put at the back of the queue

Returns:

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

Source:
Queue.scala