copyin

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

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

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

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

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

Source: copyin.scala

Linear Supertypes

CopyInIOInstances, AnyRef, Any

Type Members

type CopyInIO[A] = Free[CopyInOp, A]

Free monad over a free functor of CopyInOp; abstractly, a computation that consumes a org.postgresql.copy.CopyIn and produces a value of type A.
implicit class CopyInIOOps[A] extends AnyRef

Syntax for CopyInIO.
sealed trait CopyInOp[A] extends AnyRef

Sum type of primitive operations over a org.postgresql.copy.CopyIn.

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 CaptureCopyInIO: Capture[CopyInIO]

Capture instance for CopyInIO.
implicit val CatchableCopyInIO: Catchable[CopyInIO]

Catchable instance for CopyInIO.
object CopyInOp

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

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

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

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

Non-strict unit for capturing effects.
val endCopy: CopyInIO[Long]
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] )
val flushCopy: CopyInIO[Unit]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
val getFieldCount: CopyInIO[Int]
def getFieldFormat(a: Int): CopyInIO[Int]
val getFormat: CopyInIO[Int]
val getHandledRowCount: CopyInIO[Long]
def hashCode(): Int

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

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

Natural transformation from CopyInOp to Kleisli for the given M, consuming a org.postgresql.copy.CopyIn.
def liftCopyOut[A](s: CopyOut, k: CopyOutIO[A]): CopyInIO[A]
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( ... )
def writeToCopy(a: Array[Byte], b: Int, c: Int): CopyInIO[Unit]

Related Doc: package free

object copyin extends CopyInIOInstances

Type Members

type CopyInIO[A] = Free[CopyInOp, A]

implicit class CopyInIOOps[A] extends AnyRef

sealed trait CopyInOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureCopyInIO: Capture[CopyInIO]

implicit val CatchableCopyInIO: Catchable[CopyInIO]

object CopyInOp

final def asInstanceOf[T0]: T0

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

val cancelCopy: CopyInIO[Unit]

def clone(): AnyRef

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

val endCopy: CopyInIO[Long]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val flushCopy: CopyInIO[Unit]

final def getClass(): Class[_]

val getFieldCount: CopyInIO[Int]

def getFieldFormat(a: Int): CopyInIO[Int]

val getFormat: CopyInIO[Int]

val getHandledRowCount: CopyInIO[Long]

def hashCode(): Int

val isActive: CopyInIO[Boolean]

final def isInstanceOf[T0]: Boolean

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

def liftCopyOut[A](s: CopyOut, k: CopyOutIO[A]): CopyInIO[A]

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

def writeToCopy(a: Array[Byte], b: Int, c: Int): CopyInIO[Unit]

Inherited from CopyInIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped