sqlinput

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

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

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

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

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

Source: sqlinput.scala

Linear Supertypes

AnyRef, Any

Type Members

type SQLInputIO[A] = Free[SQLInputOp, A]

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

Syntax for SQLInputIO.
sealed trait SQLInputOp[A] extends AnyRef

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

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 CaptureSQLInputIO: Capture[SQLInputIO]

Capture instance for SQLInputIO.
implicit val CatchableSQLInputIO: Catchable[SQLInputIO]

Catchable instance for SQLInputIO.
object SQLInputOp

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

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): SQLInputIO[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] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

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

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

Definition Classes
Any
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): SQLInputIO[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: (SQLInput) ⇒ A): SQLInputIO[A]

Backdoor for arbitrary computations on the underlying SQLInput.
val readArray: SQLInputIO[Array]
val readAsciiStream: SQLInputIO[InputStream]
val readBigDecimal: SQLInputIO[BigDecimal]
val readBinaryStream: SQLInputIO[InputStream]
val readBlob: SQLInputIO[Blob]
val readBoolean: SQLInputIO[Boolean]
val readByte: SQLInputIO[Byte]
val readBytes: SQLInputIO[Array[Byte]]
val readCharacterStream: SQLInputIO[Reader]
val readClob: SQLInputIO[Clob]
val readDate: SQLInputIO[Date]
val readDouble: SQLInputIO[Double]
val readFloat: SQLInputIO[Float]
val readInt: SQLInputIO[Int]
val readLong: SQLInputIO[Long]
val readNClob: SQLInputIO[NClob]
val readNString: SQLInputIO[String]
val readObject: SQLInputIO[AnyRef]
val readRef: SQLInputIO[Ref]
val readRowId: SQLInputIO[RowId]
val readSQLXML: SQLInputIO[SQLXML]
val readShort: SQLInputIO[Short]
val readString: SQLInputIO[String]
val readTime: SQLInputIO[Time]
val readTimestamp: SQLInputIO[Timestamp]
val readURL: SQLInputIO[URL]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

Natural transformation from SQLInputIO to Kleisli for the given M, consuming a java.sql.SQLInput.
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( ... )
val wasNull: SQLInputIO[Boolean]

Related Doc: package free

object sqlinput

Type Members

type SQLInputIO[A] = Free[SQLInputOp, A]

implicit class SQLInputIOOps[A] extends AnyRef

sealed trait SQLInputOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureSQLInputIO: Capture[SQLInputIO]

implicit val CatchableSQLInputIO: Catchable[SQLInputIO]

object SQLInputOp

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

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

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (SQLInput) ⇒ A): SQLInputIO[A]

val readArray: SQLInputIO[Array]

val readAsciiStream: SQLInputIO[InputStream]

val readBigDecimal: SQLInputIO[BigDecimal]

val readBinaryStream: SQLInputIO[InputStream]

val readBlob: SQLInputIO[Blob]

val readBoolean: SQLInputIO[Boolean]

val readByte: SQLInputIO[Byte]

val readBytes: SQLInputIO[Array[Byte]]

val readCharacterStream: SQLInputIO[Reader]

val readClob: SQLInputIO[Clob]

val readDate: SQLInputIO[Date]

val readDouble: SQLInputIO[Double]

val readFloat: SQLInputIO[Float]

val readInt: SQLInputIO[Int]

val readLong: SQLInputIO[Long]

val readNClob: SQLInputIO[NClob]

val readNString: SQLInputIO[String]

val readObject: SQLInputIO[AnyRef]

val readRef: SQLInputIO[Ref]

val readRowId: SQLInputIO[RowId]

val readSQLXML: SQLInputIO[SQLXML]

val readShort: SQLInputIO[Short]

val readString: SQLInputIO[String]

val readTime: SQLInputIO[Time]

val readTimestamp: SQLInputIO[Timestamp]

val readURL: SQLInputIO[URL]

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

def toString(): String

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

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

val wasNull: SQLInputIO[Boolean]

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped