Object

doobie.free

sqlinput

Related Doc: package free

Permalink

object 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
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. sqlinput
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

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

    Permalink

    Free monad over a free functor of SQLInputOp; abstractly, a computation that consumes a java.sql.SQLInput and produces a value of type A.

  2. implicit class SQLInputIOOps[A] extends AnyRef

    Permalink

    Syntax for SQLInputIO.

  3. sealed trait SQLInputOp[A] extends AnyRef

    Permalink

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

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. implicit val CaptureSQLInputIO: Capture[SQLInputIO]

    Permalink

    Capture instance for SQLInputIO.

  5. implicit val CatchableSQLInputIO: Catchable[SQLInputIO]

    Permalink

    Catchable instance for SQLInputIO.

  6. object SQLInputOp

    Permalink

    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.

  7. final def asInstanceOf[T0]: T0

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

    Permalink

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

  9. def clone(): AnyRef

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

    Permalink

    Non-strict unit for capturing effects.

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

    Permalink
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  15. def hashCode(): Int

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

    Permalink

    Natural transformation from SQLInputOp to Kleisli for the given M, consuming a java.sql.SQLInput.

  17. final def isInstanceOf[T0]: Boolean

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

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. def raw[A](f: (SQLInput) ⇒ A): SQLInputIO[A]

    Permalink

    Backdoor for arbitrary computations on the underlying SQLInput.

  23. val readArray: SQLInputIO[Array]

    Permalink

  24. val readAsciiStream: SQLInputIO[InputStream]

    Permalink

  25. val readBigDecimal: SQLInputIO[BigDecimal]

    Permalink

  26. val readBinaryStream: SQLInputIO[InputStream]

    Permalink

  27. val readBlob: SQLInputIO[Blob]

    Permalink

  28. val readBoolean: SQLInputIO[Boolean]

    Permalink

  29. val readByte: SQLInputIO[Byte]

    Permalink

  30. val readBytes: SQLInputIO[Array[Byte]]

    Permalink

  31. val readCharacterStream: SQLInputIO[Reader]

    Permalink

  32. val readClob: SQLInputIO[Clob]

    Permalink

  33. val readDate: SQLInputIO[Date]

    Permalink

  34. val readDouble: SQLInputIO[Double]

    Permalink

  35. val readFloat: SQLInputIO[Float]

    Permalink

  36. val readInt: SQLInputIO[Int]

    Permalink

  37. val readLong: SQLInputIO[Long]

    Permalink

  38. val readNClob: SQLInputIO[NClob]

    Permalink

  39. val readNString: SQLInputIO[String]

    Permalink

  40. val readObject: SQLInputIO[AnyRef]

    Permalink

  41. val readRef: SQLInputIO[Ref]

    Permalink

  42. val readRowId: SQLInputIO[RowId]

    Permalink

  43. val readSQLXML: SQLInputIO[SQLXML]

    Permalink

  44. val readShort: SQLInputIO[Short]

    Permalink

  45. val readString: SQLInputIO[String]

    Permalink

  46. val readTime: SQLInputIO[Time]

    Permalink

  47. val readTimestamp: SQLInputIO[Timestamp]

    Permalink

  48. val readURL: SQLInputIO[URL]

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  50. def toString(): String

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

    Permalink

    Natural transformation from SQLInputIO to M, given a java.sql.SQLInput.

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

    Permalink

    Natural transformation from SQLInputIO to Kleisli for the given M, consuming a java.sql.SQLInput.

  53. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  55. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. val wasNull: SQLInputIO[Boolean]

    Permalink

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped