ref

Algebra and free monad for primitive operations over a java.sql.Ref. This is a low-level API that exposes lifecycle-managed JDBC objects directly and is intended mainly for library developers. End users will prefer a safer, higher-level API such as that provided in the doobie.hi package.

RefIO is a free monad that must be run via an interpreter, most commonly via natural transformation of its underlying algebra RefOp to another monad via Free#foldMap.

The library provides a natural transformation to Kleisli[M, Ref, A] for any exception-trapping (Catchable) and effect-capturing (Capture) monad M. Such evidence is provided for Task, IO, and stdlib Future; and transK[M] is provided as syntax.

// An action to run
val a: RefIO[Foo] = ...

// A JDBC object
val s: Ref = ...

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)

Source: ref.scala

Linear Supertypes

AnyRef, Any

Type Members

type RefIO[A] = Free[RefOp, A]

Free monad over a free functor of RefOp; abstractly, a computation that consumes a java.sql.Ref and produces a value of type A.
implicit class RefIOOps[A] extends AnyRef

Syntax for RefIO.
sealed trait RefOp[A] extends AnyRef

Sum type of primitive operations over a java.sql.Ref.

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
implicit val CaptureRefIO: Capture[RefIO]

Capture instance for RefIO.
implicit val CatchableRefIO: Catchable[RefIO]

Catchable instance for RefIO.
object RefOp

Module of constructors for RefOp.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def attempt[A](a: RefIO[A]): RefIO[\/[Throwable, A]]

Lift a RefIO[A] into an exception-capturing RefIO[Throwable \/ A].
def clone(): AnyRef

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

Non-strict unit for capturing effects.
final def eq(arg0: AnyRef): Boolean

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

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
val getBaseTypeName: RefIO[String]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getObject(a: Map[String, Class[_]]): RefIO[AnyRef]
val getObject: RefIO[AnyRef]
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefOp, [γ]Kleisli[M, Ref, γ]]

Natural transformation from RefOp to Kleisli for the given M, consuming a java.sql.Ref.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): RefIO[A]

Lift a different type of program that has a default Kleisli interpreter.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def raw[A](f: (Ref) ⇒ A): RefIO[A]

Backdoor for arbitrary computations on the underlying Ref.
def setObject(a: AnyRef): RefIO[Unit]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trans[M[_]](c: Ref)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefIO, M]

Natural transformation from RefIO to M, given a java.sql.Ref.
def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefIO, [γ]Kleisli[M, Ref, γ]]

Natural transformation from RefIO to Kleisli for the given M, consuming a java.sql.Ref.
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( ... )

object ref

Type Members

type RefIO[A] = Free[RefOp, A]

implicit class RefIOOps[A] extends AnyRef

sealed trait RefOp[A] extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

implicit val CaptureRefIO: Capture[RefIO]

implicit val CatchableRefIO: Catchable[RefIO]

object RefOp

final def asInstanceOf[T0]: T0

def attempt[A](a: RefIO[A]): RefIO[\/[Throwable, A]]

def clone(): AnyRef

def delay[A](a: ⇒ A): RefIO[A]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val getBaseTypeName: RefIO[String]

final def getClass(): Class[_]

def getObject(a: Map[String, Class[_]]): RefIO[AnyRef]

val getObject: RefIO[AnyRef]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefOp, [γ]Kleisli[M, Ref, γ]]

final def isInstanceOf[T0]: Boolean

def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): RefIO[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (Ref) ⇒ A): RefIO[A]

def setObject(a: AnyRef): RefIO[Unit]

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

def toString(): String

def trans[M[_]](c: Ref)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefIO, M]

def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[RefIO, [γ]Kleisli[M, Ref, γ]]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped