fastpath

Algebra and free monad for primitive operations over a org.postgresql.fastpath.Fastpath. 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.

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

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

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

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

Source: fastpath.scala

Linear Supertypes

FastpathIOInstances, AnyRef, Any

Type Members

type FastpathIO[A] = Free[FastpathOp, A]

Free monad over a free functor of FastpathOp; abstractly, a computation that consumes a org.postgresql.fastpath.Fastpath and produces a value of type A.
implicit class FastpathIOOps[A] extends AnyRef

Syntax for FastpathIO.
sealed trait FastpathOp[A] extends AnyRef

Sum type of primitive operations over a org.postgresql.fastpath.Fastpath.

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 CaptureFastpathIO: Capture[FastpathIO]

Capture instance for FastpathIO.
implicit val CatchableFastpathIO: Catchable[FastpathIO]

Catchable instance for FastpathIO.
object FastpathOp

Module of constructors for FastpathOp.
Module of constructors for FastpathOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the fastpath module.
def addFunction(a: String, b: Int): FastpathIO[Unit]
def addFunctions(a: ResultSet): FastpathIO[Unit]
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): FastpathIO[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 fastpath(a: Int, b: Boolean, c: Array[FastpathArg]): FastpathIO[AnyRef]
def fastpath(a: String, b: Boolean, c: Array[FastpathArg]): FastpathIO[AnyRef]
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 getData(a: String, b: Array[FastpathArg]): FastpathIO[Array[Byte]]
def getID(a: String): FastpathIO[Int]
def getInteger(a: String, b: Array[FastpathArg]): FastpathIO[Int]
def getOID(a: String, b: Array[FastpathArg]): FastpathIO[Long]
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[FastpathOp, [γ$0$]Kleisli[M, Fastpath, γ$0$]]

Natural transformation from FastpathOp to Kleisli for the given M, consuming a org.postgresql.fastpath.Fastpath.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
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 fastpath extends FastpathIOInstances

Type Members

type FastpathIO[A] = Free[FastpathOp, A]

implicit class FastpathIOOps[A] extends AnyRef

sealed trait FastpathOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureFastpathIO: Capture[FastpathIO]

implicit val CatchableFastpathIO: Catchable[FastpathIO]

object FastpathOp

def addFunction(a: String, b: Int): FastpathIO[Unit]

def addFunctions(a: ResultSet): FastpathIO[Unit]

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fastpath(a: Int, b: Boolean, c: Array[FastpathArg]): FastpathIO[AnyRef]

def fastpath(a: String, b: Boolean, c: Array[FastpathArg]): FastpathIO[AnyRef]

def finalize(): Unit

final def getClass(): Class[_]

def getData(a: String, b: Array[FastpathArg]): FastpathIO[Array[Byte]]

def getID(a: String): FastpathIO[Int]

def getInteger(a: String, b: Array[FastpathArg]): FastpathIO[Int]

def getOID(a: String, b: Array[FastpathArg]): FastpathIO[Long]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[FastpathOp, [γ$0$]Kleisli[M, Fastpath, γ$0$]]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

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

def toString(): String

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from FastpathIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped