trait Dequeue[F[_], A] extends Queue[F, A] with DequeueSource[F, A] with DequeueSink[F, A]
- Self Type
- Dequeue[F, A]
- Source
- Dequeue.scala
- Alphabetic
- By Inheritance
- Dequeue
- DequeueSink
- DequeueSource
- Queue
- QueueSink
- QueueSource
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def offerBack(a: A): F[Unit]
Enqueues the given element at the back of the dequeue, possibly fiber blocking until sufficient capacity becomes available.
Enqueues the given element at the back of the dequeue, possibly fiber blocking until sufficient capacity becomes available.
- a
the element to be put at the back of the dequeue
- Definition Classes
- DequeueSink
- abstract def offerFront(a: A): F[Unit]
Enqueues the given element at the front of the dequeue, possibly semantically blocking until sufficient capacity becomes available.
Enqueues the given element at the front of the dequeue, possibly semantically blocking until sufficient capacity becomes available.
- a
the element to be put at the back of the dequeue
- Definition Classes
- DequeueSink
- abstract def reverse: F[Unit]
Reverse the dequeue in constant time
- abstract def size: F[Int]
- Definition Classes
- QueueSource
- abstract def takeBack: F[A]
Dequeues an element from the back of the dequeue, possibly fiber blocking until an element becomes available.
Dequeues an element from the back of the dequeue, possibly fiber blocking until an element becomes available.
- Definition Classes
- DequeueSource
- abstract def takeFront: F[A]
Dequeues an element from the front of the dequeue, possibly semantically blocking until an element becomes available.
Dequeues an element from the front of the dequeue, possibly semantically blocking until an element becomes available.
- Definition Classes
- DequeueSource
- abstract def tryOfferBack(a: A): F[Boolean]
Attempts to enqueue the given element at the back of the dequeue without semantically blocking.
Attempts to enqueue the given element at the back of the dequeue without semantically blocking.
- a
the element to be put at the back of the dequeue
- returns
an effect that describes whether the enqueuing of the given element succeeded without blocking
- Definition Classes
- DequeueSink
- abstract def tryOfferFront(a: A): F[Boolean]
Attempts to enqueue the given element at the front of the dequeue without semantically blocking.
Attempts to enqueue the given element at the front of the dequeue without semantically blocking.
- a
the element to be put at the back of the dequeue
- returns
an effect that describes whether the enqueuing of the given element succeeded without blocking
- Definition Classes
- DequeueSink
- 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
Nonedenoting that no element was available
- Definition Classes
- DequeueSource
- 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
Nonedenoting that no element was available
- Definition Classes
- DequeueSource
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def mapK[G[_]](f: ~>[F, G]): Dequeue[G, A]
Modifies the context in which this dequeue is executed using the natural transformation
f. - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def offer(a: A): F[Unit]
Alias for offerBack in order to implement Queue
Alias for offerBack in order to implement Queue
- a
the element to be put at the back of the queue
- Definition Classes
- DequeueSink → QueueSink
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def take: F[A]
Alias for takeFront in order to implement Queue
Alias for takeFront in order to implement Queue
- Definition Classes
- DequeueSource → QueueSource
- def toString(): String
- Definition Classes
- AnyRef → Any
- def tryOffer(a: A): F[Boolean]
Alias for tryOfferBack in order to implement Queue
Alias for tryOfferBack in order to implement Queue
- 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
- Definition Classes
- DequeueSink → QueueSink
- def tryOfferBackN(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.
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
tryOfferand does not offer any additional performance benefits.- 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.
- Definition Classes
- DequeueSink
- def tryOfferFrontN(list: List[A])(implicit F: Monad[F]): F[List[A]]
Attempts to enqueue the given elements at the front of the queue without semantically blocking.
Attempts to enqueue the given elements at the front 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
tryOfferand does not offer any additional performance benefits.- list
the elements to be put at the front of the queue
- returns
an effect that contains the remaining valus that could not be offered.
- Definition Classes
- DequeueSink
- 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.
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
tryOfferand does not offer any additional performance benefits.- 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.
- Definition Classes
- QueueSink
- 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
Nonedenoting that no element was available
- Definition Classes
- DequeueSource → QueueSource
- 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
Nonewill try to dequeue the whole queue.- returns
an effect that contains the dequeued elements
- Definition Classes
- DequeueSource
- 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
Nonewill try to dequeue the whole queue.- returns
an effect that contains the dequeued elements
- Definition Classes
- DequeueSource
- 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
Nonewill try to dequeue the whole queue.- returns
an effect that contains the dequeued elements
- Definition Classes
- QueueSource
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()