sqloutput

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

SQLOutputIO is a free monad that must be run via an interpreter, most commonly via natural transformation of its underlying algebra SQLOutputOp to another monad via Free.runFC.

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

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

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

Source: sqloutput.scala

Linear Supertypes

AnyRef, Any

Type Members

type SQLOutputIO[A] = Free[[x]Coyoneda[SQLOutputOp, x], A]

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

Syntax for SQLOutputIO.
sealed trait SQLOutputOp[A] extends AnyRef

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

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 CaptureSQLOutputIO: Capture[SQLOutputIO]

Capture instance for SQLOutputIO.
implicit val CatchableSQLOutputIO: Catchable[SQLOutputIO]

Catchable instance for SQLOutputIO.
implicit val MonadSQLOutputIO: Monad[SQLOutputIO]

Monad instance for SQLOutputIO (can't be inferred).
object SQLOutputOp

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

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): SQLOutputIO[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]): ~>[SQLOutputOp, [γ]Kleisli[M, SQLOutput, γ]]

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

Definition Classes
Any
def liftBlob[A](s: Blob, k: BlobIO[A]): SQLOutputIO[A]
def liftCallableStatement[A](s: CallableStatement, k: CallableStatementIO[A]): SQLOutputIO[A]
def liftClob[A](s: Clob, k: ClobIO[A]): SQLOutputIO[A]
def liftConnection[A](s: Connection, k: ConnectionIO[A]): SQLOutputIO[A]
def liftDatabaseMetaData[A](s: DatabaseMetaData, k: DatabaseMetaDataIO[A]): SQLOutputIO[A]
def liftDriver[A](s: Driver, k: DriverIO[A]): SQLOutputIO[A]
def liftNClob[A](s: NClob, k: NClobIO[A]): SQLOutputIO[A]
def liftPreparedStatement[A](s: PreparedStatement, k: PreparedStatementIO[A]): SQLOutputIO[A]
def liftRef[A](s: Ref, k: RefIO[A]): SQLOutputIO[A]
def liftResultSet[A](s: ResultSet, k: ResultSetIO[A]): SQLOutputIO[A]
def liftSQLData[A](s: SQLData, k: SQLDataIO[A]): SQLOutputIO[A]
def liftSQLInput[A](s: SQLInput, k: SQLInputIO[A]): SQLOutputIO[A]
def liftStatement[A](s: Statement, k: StatementIO[A]): SQLOutputIO[A]
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: (SQLOutput) ⇒ A): SQLOutputIO[A]

Backdoor for arbitrary computations on the underlying SQLOutput.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

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

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

Natural transformation from SQLOutputIO to Kleisli for the given M, consuming a java.sql.SQLOutput.
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( ... )
def writeArray(a: Array): SQLOutputIO[Unit]
def writeAsciiStream(a: InputStream): SQLOutputIO[Unit]
def writeBigDecimal(a: BigDecimal): SQLOutputIO[Unit]
def writeBinaryStream(a: InputStream): SQLOutputIO[Unit]
def writeBlob(a: Blob): SQLOutputIO[Unit]
def writeBoolean(a: Boolean): SQLOutputIO[Unit]
def writeByte(a: Byte): SQLOutputIO[Unit]
def writeBytes(a: Array[Byte]): SQLOutputIO[Unit]
def writeCharacterStream(a: Reader): SQLOutputIO[Unit]
def writeClob(a: Clob): SQLOutputIO[Unit]
def writeDate(a: Date): SQLOutputIO[Unit]
def writeDouble(a: Double): SQLOutputIO[Unit]
def writeFloat(a: Float): SQLOutputIO[Unit]
def writeInt(a: Int): SQLOutputIO[Unit]
def writeLong(a: Long): SQLOutputIO[Unit]
def writeNClob(a: NClob): SQLOutputIO[Unit]
def writeNString(a: String): SQLOutputIO[Unit]
def writeObject(a: SQLData): SQLOutputIO[Unit]
def writeRef(a: Ref): SQLOutputIO[Unit]
def writeRowId(a: RowId): SQLOutputIO[Unit]
def writeSQLXML(a: SQLXML): SQLOutputIO[Unit]
def writeShort(a: Short): SQLOutputIO[Unit]
def writeString(a: String): SQLOutputIO[Unit]
def writeStruct(a: Struct): SQLOutputIO[Unit]
def writeTime(a: Time): SQLOutputIO[Unit]
def writeTimestamp(a: Timestamp): SQLOutputIO[Unit]
def writeURL(a: URL): SQLOutputIO[Unit]

Related Doc: package free

object sqloutput

Type Members

type SQLOutputIO[A] = Free[[x]Coyoneda[SQLOutputOp, x], A]

implicit class SQLOutputIOOps[A] extends AnyRef

sealed trait SQLOutputOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureSQLOutputIO: Capture[SQLOutputIO]

implicit val CatchableSQLOutputIO: Catchable[SQLOutputIO]

implicit val MonadSQLOutputIO: Monad[SQLOutputIO]

object SQLOutputOp

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

def delay[A](a: ⇒ A): SQLOutputIO[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]): ~>[SQLOutputOp, [γ]Kleisli[M, SQLOutput, γ]]

final def isInstanceOf[T0]: Boolean

def liftBlob[A](s: Blob, k: BlobIO[A]): SQLOutputIO[A]

def liftCallableStatement[A](s: CallableStatement, k: CallableStatementIO[A]): SQLOutputIO[A]

def liftClob[A](s: Clob, k: ClobIO[A]): SQLOutputIO[A]

def liftConnection[A](s: Connection, k: ConnectionIO[A]): SQLOutputIO[A]

def liftDatabaseMetaData[A](s: DatabaseMetaData, k: DatabaseMetaDataIO[A]): SQLOutputIO[A]

def liftDriver[A](s: Driver, k: DriverIO[A]): SQLOutputIO[A]

def liftNClob[A](s: NClob, k: NClobIO[A]): SQLOutputIO[A]

def liftPreparedStatement[A](s: PreparedStatement, k: PreparedStatementIO[A]): SQLOutputIO[A]

def liftRef[A](s: Ref, k: RefIO[A]): SQLOutputIO[A]

def liftResultSet[A](s: ResultSet, k: ResultSetIO[A]): SQLOutputIO[A]

def liftSQLData[A](s: SQLData, k: SQLDataIO[A]): SQLOutputIO[A]

def liftSQLInput[A](s: SQLInput, k: SQLInputIO[A]): SQLOutputIO[A]

def liftStatement[A](s: Statement, k: StatementIO[A]): SQLOutputIO[A]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def raw[A](f: (SQLOutput) ⇒ A): SQLOutputIO[A]

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

def toString(): String

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

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def writeArray(a: Array): SQLOutputIO[Unit]

def writeAsciiStream(a: InputStream): SQLOutputIO[Unit]

def writeBigDecimal(a: BigDecimal): SQLOutputIO[Unit]

def writeBinaryStream(a: InputStream): SQLOutputIO[Unit]

def writeBlob(a: Blob): SQLOutputIO[Unit]

def writeBoolean(a: Boolean): SQLOutputIO[Unit]

def writeByte(a: Byte): SQLOutputIO[Unit]

def writeBytes(a: Array[Byte]): SQLOutputIO[Unit]

def writeCharacterStream(a: Reader): SQLOutputIO[Unit]

def writeClob(a: Clob): SQLOutputIO[Unit]

def writeDate(a: Date): SQLOutputIO[Unit]

def writeDouble(a: Double): SQLOutputIO[Unit]

def writeFloat(a: Float): SQLOutputIO[Unit]

def writeInt(a: Int): SQLOutputIO[Unit]

def writeLong(a: Long): SQLOutputIO[Unit]

def writeNClob(a: NClob): SQLOutputIO[Unit]

def writeNString(a: String): SQLOutputIO[Unit]

def writeObject(a: SQLData): SQLOutputIO[Unit]

def writeRef(a: Ref): SQLOutputIO[Unit]

def writeRowId(a: RowId): SQLOutputIO[Unit]

def writeSQLXML(a: SQLXML): SQLOutputIO[Unit]

def writeShort(a: Short): SQLOutputIO[Unit]

def writeString(a: String): SQLOutputIO[Unit]

def writeStruct(a: Struct): SQLOutputIO[Unit]

def writeTime(a: Time): SQLOutputIO[Unit]

def writeTimestamp(a: Timestamp): SQLOutputIO[Unit]

def writeURL(a: URL): SQLOutputIO[Unit]

Inherited from AnyRef

Inherited from Any

Algebra