Raii

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
def apply[A](parallelTryT: Parallel[[+β$11$]TryT[[+β$10$]ResourceT[[+A]Continuation[Unit, A], β$10$], β$11$], A]): Raii[A]
final def asInstanceOf[T0]: T0

Definition Classes
Any
def async[A](start: ((Resource[UnitContinuation, Try[A]]) ⇒ Unit) ⇒ Unit): Raii[A]
def autoCloseable[A <: AutoCloseable](value: ⇒ A): Raii[A]

Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close.
Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
def autoCloseable[A <: AutoCloseable](continuation: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close.
Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
monadicCloseable for creating a Raii whose release operation is raii.
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
def autoCloseable[A <: AutoCloseable](future: Task[A]): Raii[A]

Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close.
Returns a non-strict Raii whose release operation is java.lang.AutoCloseable.close. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
monadicCloseable for creating a Raii whose release operation is raii.
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](value: ⇒ A): Raii[A]

Returns a non-strict Raii whose release operation is no-op.
Returns a non-strict Raii whose release operation is no-op. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii. A must be a garbage-collected type that does not hold native resource.

See also
autoCloseable for auto-closeable Raii
pure for strict garbage collected Raii
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any

def execute[A](value: ⇒ A)(implicit executorContext: ExecutionContext): Raii[A]

Returns a Raii that runs in executorContext.

Note

This method is usually used for changing the current thread.

import java.util.concurrent._
import scala.concurrent._
import cats.syntax.all._
import com.thoughtworks.zerocost.task._
import com.thoughtworks.zerocost.raii._
implicit def executorContext = ExecutionContext.fromExecutor(Executors.newSingleThreadExecutor())
val mainThread = Thread.currentThread
val assertionRaii = for {
  _ <- Raii.delay(())
  threadBeforeJump = Thread.currentThread
  _ = threadBeforeJump should be(mainThread)
  _ <- Raii.execute(())
  threadAfterJump = Thread.currentThread
} yield {
  threadAfterJump shouldNot be(mainThread)
}
assertionRaii.run.toFuture

Returns a non-strict Raii whose release operation is no-op. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also

autoCloseable for auto-closeable Raii

pure for strict garbage collected Raii

def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def garbageCollected[A](continuation: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

Returns a non-strict Raii whose release operation is no-op.
Returns a non-strict Raii whose release operation is no-op. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii. A must be a garbage-collected type that does not hold native resource.

See also
delay for non-strict garbage collected Raii
autoCloseable for auto-closeable Raii
pure for strict garbage collected Raii
def garbageCollected[A](future: Task[A]): Raii[A]

Returns a non-strict Raii whose release operation is no-op.
Returns a non-strict Raii whose release operation is no-op. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii. A must be a garbage-collected type that does not hold native resource.

See also
delay for non-strict garbage collected Raii
autoCloseable for auto-closeable Raii
pure for strict garbage collected Raii
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](value: ⇒ A): Raii[A]

Returns a non-strict Raii whose release operation is raii.
Returns a non-strict Raii whose release operation is raii. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
autoCloseable for auto-closeable Raii
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](future: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

Returns a non-strict Raii whose release operation is raii.
Returns a non-strict Raii whose release operation is raii. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
autoCloseable for auto-closeable Raii
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](future: Task[A]): Raii[A]

Returns a non-strict Raii whose release operation is raii.
Returns a non-strict Raii whose release operation is raii. Since the Raii is non-strict, A will be recreated each time it is sequenced into a larger Raii.

See also
autoCloseable for auto-closeable Raii
delay for non-strict garbage collected Raii
pure for strict garbage collected Raii
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def nested[A](raiiA: Raii[A]): Raii[A]

Returns a nested scope of raiiA.
Returns a nested scope of raiiA.
All resources created during building A will be released after A is built.

Note
This method has the same behavior as Raii.garbageCollected(raiiA.run).
,
A must be a garbage collected type, i.e. not a java.lang.AutoCloseable or a resourcet.MonadicCloseable
See also
AsynchronousRaiiOps.run for running a Raii as a Task.
garbageCollected for creating a garbage collected Raii
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def pure[A](value: A): Raii[A]

Converts a strict value to a Raii whose release operation is no-op.
Converts a strict value to a Raii whose release operation is no-op. A must be a garbage-collected type that does not hold native resource.

See also
autoCloseable for auto-closeable Raii
delay for non-strict garbage collected Raii
def resource[A](resource: ⇒ Resource[UnitContinuation, A]): Raii[A]
def safeAsync[A](start: ((Resource[UnitContinuation, Try[A]]) ⇒ TailRec[Unit]) ⇒ TailRec[Unit]): Raii[A]
def suspend[A](doValue: ⇒ Raii[A]): Raii[A]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def unapply[A](raii: Raii[A]): Some[Parallel[[+β$12$]TryT[[+β$13$]ResourceT[[+A]Continuation[Unit, A], β$13$], β$12$], A]]
final def wait(): Unit

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

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

Definition Classes
AnyRef
Annotations
@throws( ... )

Deprecated Value Members

def scoped[A <: AutoCloseable](future: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

Annotations
@deprecated
Deprecated
(Since version 3.0.0) Use autoCloseable instead.
def scoped[A <: AutoCloseable](future: Task[A]): Raii[A]

Annotations
@deprecated
Deprecated
(Since version 3.0.0) Use autoCloseable instead.

Related Doc: package raii

object Raii

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def apply[A](parallelTryT: Parallel[[+β$11$]TryT[[+β$10$]ResourceT[[+A]Continuation[Unit, A], β$10$], β$11$], A]): Raii[A]

final def asInstanceOf[T0]: T0

def async[A](start: ((Resource[UnitContinuation, Try[A]]) ⇒ Unit) ⇒ Unit): Raii[A]

def autoCloseable[A <: AutoCloseable](value: ⇒ A): Raii[A]

def autoCloseable[A <: AutoCloseable](continuation: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

def autoCloseable[A <: AutoCloseable](future: Task[A]): Raii[A]

def clone(): AnyRef

def delay[A](value: ⇒ A): Raii[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def execute[A](value: ⇒ A)(implicit executorContext: ExecutionContext): Raii[A]

def finalize(): Unit

def garbageCollected[A](continuation: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

def garbageCollected[A](future: Task[A]): Raii[A]

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](value: ⇒ A): Raii[A]

def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](future: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

def monadicCloseable[A <: MonadicCloseable[UnitContinuation]](future: Task[A]): Raii[A]

final def ne(arg0: AnyRef): Boolean

def nested[A](raiiA: Raii[A]): Raii[A]

final def notify(): Unit

final def notifyAll(): Unit

def pure[A](value: A): Raii[A]

def resource[A](resource: ⇒ Resource[UnitContinuation, A]): Raii[A]

def safeAsync[A](start: ((Resource[UnitContinuation, Try[A]]) ⇒ TailRec[Unit]) ⇒ TailRec[Unit]): Raii[A]

def suspend[A](doValue: ⇒ Raii[A]): Raii[A]

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

def toString(): String

def unapply[A](raii: Raii[A]): Some[Parallel[[+β$12$]TryT[[+β$13$]ResourceT[[+A]Continuation[Unit, A], β$13$], β$12$], A]]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Deprecated Value Members

def scoped[A <: AutoCloseable](future: UnitContinuation[A], dummyImplicit: DummyImplicit = DummyImplicit.dummyImplicit): Raii[A]

def scoped[A <: AutoCloseable](future: Task[A]): Raii[A]

Inherited from AnyRef

Inherited from Any

Ungrouped