Dequeue

cats.effect.std.Dequeue$
See theDequeue companion trait
object Dequeue

Attributes

Companion:
trait
Source:
Dequeue.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Dequeue.type

Members list

Concise view

Value members

Concrete methods

def bounded[F[_], A](capacity: Int)(implicit F: GenConcurrent[F, _]): F[Dequeue[F, A]]

Constructs an empty, bounded dequeue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent. When the queue is full (contains exactly capacity elements), every next Queue#offer will be backpressured (i.e. the Queue#offer blocks semantically).

Constructs an empty, bounded dequeue holding up to capacity elements for F data types that are cats.effect.kernel.GenConcurrent. When the queue is full (contains exactly capacity elements), every next Queue#offer will be backpressured (i.e. the Queue#offer blocks semantically).

Attributes

capacity

the maximum capacity of the queue

Returns:

an empty, bounded queue

Source:
Dequeue.scala
def unbounded[F[_], A](implicit F: GenConcurrent[F, _]): F[Dequeue[F, A]]

Constructs an empty, unbounded dequeue for F data types that are cats.effect.kernel.GenConcurrent. Queue#offer never blocks semantically, as there is always spare capacity in the queue.

Constructs an empty, unbounded dequeue for F data types that are cats.effect.kernel.GenConcurrent. Queue#offer never blocks semantically, as there is always spare capacity in the queue.

Attributes

Returns:

an empty, unbounded queue

Source:
Dequeue.scala

Implicits

Implicits

implicit def catsInvariantForDequeue[F[_] : Functor]: Invariant[[_] =>> Dequeue[F, _$7]]

Attributes

Source:
Dequeue.scala