doobie.free

sqloutput

object 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#foldMap.

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
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. sqloutput
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type SQLOutputIO[A] = Free[SQLOutputOp, 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.

  2. implicit class SQLOutputIOOps[A] extends AnyRef

    Syntax for SQLOutputIO.

  3. sealed trait SQLOutputOp[A] extends AnyRef

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. implicit val CaptureSQLOutputIO: Capture[SQLOutputIO]

    Capture instance for SQLOutputIO.

  7. implicit val CatchableSQLOutputIO: Catchable[SQLOutputIO]

    Catchable instance for SQLOutputIO.

  8. object SQLOutputOp

    Module of constructors for SQLOutputOp.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

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

    Lift a SQLOutputIO[A] into an exception-capturing SQLOutputIO[Throwable \/ A].

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def delay[A](a: ⇒ A): SQLOutputIO[A]

    Non-strict unit for capturing effects.

  13. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  18. 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.

  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Lift a different type of program that has a default Kleisli interpreter.

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Backdoor for arbitrary computations on the underlying SQLOutput.

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

    Definition Classes
    AnyRef

  26. def toString(): String

    Definition Classes
    AnyRef → Any

  27. 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.

  28. 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.

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  31. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped