Object

com.thoughtworks.raii

invariant

Related Doc: package raii

Permalink

object invariant extends InvariantResourceTInstances0

The namespace that contains the invariant ResourceT.

Usage:

import com.thoughtworks.raii.invariant._
Source
covariant.scala
Linear Supertypes
InvariantResourceTInstances0, InvariantResourceTInstances1, InvariantResourceTInstances2, InvariantResourceTInstances3, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. invariant
  2. InvariantResourceTInstances0
  3. InvariantResourceTInstances1
  4. InvariantResourceTInstances2
  5. InvariantResourceTInstances3
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. implicit final class InvariantResourceTOps[F[_], A] extends AnyRef

    Permalink
  2. trait MonadicCloseable[F[_]] extends Any

    Permalink

    An object that may hold resources until it is closed.

    An object that may hold resources until it is closed.

    Similar to java.lang.AutoCloseable except the close operation is monadic.

  3. trait Resource[F[_], A] extends AnyRef

    Permalink

    A container of a value and a function to release the value.

    A container of a value and a function to release the value.

    F

    the monadic type of release

    A

    the type of value

    Note

    This Resource will become a case class. Use Resource.apply instead of new Resource[F, A] { ... }.

  4. type ResourceT[F[_], A] = invariant.OpacityTypes.ResourceT[F, A]

    Permalink

    The data structure that provides automatic resource management.

    The data structure that provides automatic resource management.

    Example:
    1. ResourceT can be used as a monad transformer for scalaz.Name

      import scalaz.Name
      import com.thoughtworks.raii.invariant._
      type RAII[A] = ResourceT[Name, A]

      Given a resource that creates temporary files

      import java.io.File
      val resource: RAII[File] = ResourceT(Name(new Resource[Name, File] {
        override val value: File = File.createTempFile("test", ".tmp");
        override val release: Name[Unit] = Name {
          val isDeleted = value.delete()
        }
      }))

      when using temporary file created by resouce in a for / yield block, those temporary files should be available.

      import scalaz.syntax.all._
      val usingResouce = for {
        tmpFile1 <- resource
        tmpFile2 <- resource
      } yield {
        tmpFile1 shouldNot be(tmpFile2)
        tmpFile1 should exist
        tmpFile2 should exist
        (tmpFile1, tmpFile2)
      }

      and those files should have been deleted after the for / yield block.

      val (tmpFile1, tmpFile2) = usingResouce.run.value
      tmpFile1 shouldNot exist
      tmpFile2 shouldNot exist
    Note

    This ResourceT type is an opacity alias to F[Resource[F, A]]. All type classes and helper functions for this ResourceT type are defined in the companion object ResourceT

  5. type Releasable[F[_], A] = Resource[F, A]

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Use Resource instead.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object Resource

    Permalink
  5. object ResourceT

    Permalink

    The companion object of ResourceT that contains converters and type classes.

    The companion object of ResourceT that contains converters and type classes.

    Note

    There are some implicit method that provides scalaz.Monads as monad transformers of F. Those monads running will collect all resources, which will be open and release altogether when ResourceT.run is called.

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. implicit def invariantResourceTApplicative[F[_]](implicit arg0: Applicative[F]): Applicative[[β$0$]invariant.OpacityTypes.ResourceT[F, β$0$]]

    Permalink

    Definition Classes
    InvariantResourceTInstances3
  14. implicit def invariantResourceTMonad[F[_]](implicit arg0: Monad[F]): Monad[[β$1$]invariant.OpacityTypes.ResourceT[F, β$1$]]

    Permalink

    Definition Classes
    InvariantResourceTInstances2
  15. implicit def invariantResourceTMonadError[F[_], S](implicit F0: MonadError[F, S]): MonadError[[β$3$]invariant.OpacityTypes.ResourceT[F, β$3$], S]

    Permalink

    Definition Classes
    InvariantResourceTInstances0
  16. implicit def invariantResourceTNondeterminism[F[_]](implicit F0: Nondeterminism[F]): Nondeterminism[[β$2$]invariant.OpacityTypes.ResourceT[F, β$2$]]

    Permalink

    Definition Classes
    InvariantResourceTInstances1
  17. implicit def invariantResourceTParallelApplicative[F[_]](implicit F0: Applicative[[A]AnyRef { ... /* 2 definitions in type refinement */ }]): Applicative[[A]AnyRef { ... /* 2 definitions in type refinement */ }]

    Permalink

  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. val opacityTypes: OpacityTypes

    Permalink

    The type-level Pimpl in order to prevent the Scala compiler seeing the actual type of ResourceT

    The type-level Pimpl in order to prevent the Scala compiler seeing the actual type of ResourceT

    Note

    For internal usage only.

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from InvariantResourceTInstances0

Inherited from InvariantResourceTInstances1

Inherited from InvariantResourceTInstances2

Inherited from InvariantResourceTInstances3

Inherited from AnyRef

Inherited from Any

Type classes

Ungrouped