Packages

object MVar

Builders for MVar.

Source
MVar.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MVar
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. final class ApplyBuilders[F[_]] extends AnyVal

    Returned by the apply builder.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def apply[F[_]](implicit F: Concurrent[F]): ApplyBuilders[F]

    Builds an MVar value for F data types that are Concurrent.

    Builds an MVar value for F data types that are Concurrent.

    Due to Concurrent's capabilities, the yielded values by MVar.take and MVar.put are cancelable.

    This builder uses the Partially-Applied Type technique.

    For creating an empty MVar:

    MVar[IO].empty[Int] <-> MVar.empty[IO, Int]

    For creating an MVar with an initial value:

    MVar[IO].init("hello") <-> MVar.init[IO, String]("hello")
    See also

    ofand empty

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  7. def empty[F[_], A](implicit F: Concurrent[F]): F[MVar2[F, A]]

    Creates a cancelable MVar that starts as empty.

    Creates a cancelable MVar that starts as empty.

    F

    is a Concurrent constraint, needed in order to describe cancelable operations

    See also

    uncancelableEmpty for non-cancelable MVars

  8. def emptyIn[F[_], G[_], A](implicit F: Sync[F], G: Concurrent[G]): F[MVar2[G, A]]

    Like empty but initializes state using another effect constructor

  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  13. def in[F[_], G[_], A](initial: A)(implicit F: Sync[F], G: Concurrent[G]): F[MVar2[G, A]]

    Like of but initializes state using another effect constructor

  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  18. def of[F[_], A](initial: A)(implicit F: Concurrent[F]): F[MVar2[F, A]]

    Creates a cancelable MVar that's initialized to an initial value.

    Creates a cancelable MVar that's initialized to an initial value.

    initial

    is a value that will be immediately available for the first read or take operation

    F

    is a Concurrent constraint, needed in order to describe cancelable operations

    See also

    uncancelableOf for non-cancelable MVars

  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. def uncancelableEmpty[F[_], A](implicit F: Async[F]): F[MVar2[F, A]]

    Creates a non-cancelable MVar that starts as empty.

    Creates a non-cancelable MVar that starts as empty.

    The resulting MVar has non-cancelable operations.

    WARN: some Async data types, like IO, can be cancelable, making uncancelable values unsafe. Such values are only useful for optimization purposes, in cases where the use case does not require cancellation or in cases in which an F[_] data type that does not support cancellation is used.

    See also

    empty for creating cancelable MVars

  22. def uncancelableEmptyIn[F[_], G[_], A](implicit F: Sync[F], G: Async[G]): F[MVar2[G, A]]

    Like uncancelableEmpty but initializes state using another effect constructor

  23. def uncancelableIn[F[_], G[_], A](initial: A)(implicit F: Sync[F], G: Async[G]): F[MVar2[G, A]]

    Like uncancelableOf but initializes state using another effect constructor

  24. def uncancelableOf[F[_], A](initial: A)(implicit F: Async[F]): F[MVar2[F, A]]

    Creates a non-cancelable MVar that's initialized to an initial value.

    Creates a non-cancelable MVar that's initialized to an initial value.

    The resulting MVar has non-cancelable operations.

    WARN: some Async data types, like IO, can be cancelable, making uncancelable values unsafe. Such values are only useful for optimization purposes, in cases where the use case does not require cancellation or in cases in which an F[_] data type that does not support cancellation is used.

    See also

    of for creating cancelable MVars

  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped