clob

Algebra and free monad for primitive operations over a java.sql.Clob. 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.

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

The library provides a natural transformation to Kleisli[M, Clob, 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: ClobIO[Foo] = ...

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

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

Source: clob.scala

Linear Supertypes

ClobIOInstances, AnyRef, Any

Type Members

type ClobIO[A] = Free[ClobOp, A]

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

Syntax for ClobIO.
sealed trait ClobOp[A] extends AnyRef

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

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
implicit val CaptureClobIO: Capture[ClobIO]

Capture instance for ClobIO.
implicit val CatchableClobIO: Catchable[ClobIO]

Catchable instance for ClobIO.
object ClobOp

Module of constructors for ClobOp.
Module of constructors for ClobOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the clob module.
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): ClobIO[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 free: ClobIO[Unit]
val getAsciiStream: ClobIO[InputStream]
def getCharacterStream(a: Long, b: Long): ClobIO[Reader]
val getCharacterStream: ClobIO[Reader]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getSubString(a: Long, b: Int): ClobIO[String]
def hashCode(): Int

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

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

Definition Classes
Any
val length: ClobIO[Long]
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): ClobIO[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 position(a: String, b: Long): ClobIO[Long]
def position(a: Clob, b: Long): ClobIO[Long]
def raw[A](f: (Clob) ⇒ A): ClobIO[A]

Backdoor for arbitrary computations on the underlying Clob.
def setAsciiStream(a: Long): ClobIO[OutputStream]
def setCharacterStream(a: Long): ClobIO[Writer]
def setString(a: Long, b: String, c: Int, d: Int): ClobIO[Int]
def setString(a: Long, b: String): ClobIO[Int]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

Natural transformation from ClobIO to Kleisli for the given M, consuming a java.sql.Clob.
def truncate(a: Long): ClobIO[Unit]
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( ... )

Related Doc: package free

object clob extends ClobIOInstances

Type Members

type ClobIO[A] = Free[ClobOp, A]

implicit class ClobIOOps[A] extends AnyRef

sealed trait ClobOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureClobIO: Capture[ClobIO]

implicit val CatchableClobIO: Catchable[ClobIO]

object ClobOp

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val free: ClobIO[Unit]

val getAsciiStream: ClobIO[InputStream]

def getCharacterStream(a: Long, b: Long): ClobIO[Reader]

val getCharacterStream: ClobIO[Reader]

final def getClass(): Class[_]

def getSubString(a: Long, b: Int): ClobIO[String]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[ClobOp, [γ$3$]Kleisli[M, Clob, γ$3$]]

final def isInstanceOf[T0]: Boolean

val length: ClobIO[Long]

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def position(a: String, b: Long): ClobIO[Long]

def position(a: Clob, b: Long): ClobIO[Long]

def raw[A](f: (Clob) ⇒ A): ClobIO[A]

def setAsciiStream(a: Long): ClobIO[OutputStream]

def setCharacterStream(a: Long): ClobIO[Writer]

def setString(a: Long, b: String, c: Int, d: Int): ClobIO[Int]

def setString(a: Long, b: String): ClobIO[Int]

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

def toString(): String

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

def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[ClobIO, [γ$4$]Kleisli[M, Clob, γ$4$]]

def truncate(a: Long): ClobIO[Unit]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from ClobIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped