largeobject

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

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

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

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

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

Source: largeobject.scala

Linear Supertypes

LargeObjectIOInstances, AnyRef, Any

Type Members

type LargeObjectIO[A] = Free[LargeObjectOp, A]

Free monad over a free functor of LargeObjectOp; abstractly, a computation that consumes a org.postgresql.largeobject.LargeObject and produces a value of type A.
implicit class LargeObjectIOOps[A] extends AnyRef

Syntax for LargeObjectIO.
sealed trait LargeObjectOp[A] extends AnyRef

Sum type of primitive operations over a org.postgresql.largeobject.LargeObject.

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 CaptureLargeObjectIO: Capture[LargeObjectIO]

Capture instance for LargeObjectIO.
implicit val CatchableLargeObjectIO: Catchable[LargeObjectIO]

Catchable instance for LargeObjectIO.
object LargeObjectOp

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

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val close: LargeObjectIO[Unit]
val copy: LargeObjectIO[LargeObject]
def delay[A](a: ⇒ A): LargeObjectIO[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
val getInputStream: LargeObjectIO[InputStream]
val getLongOID: LargeObjectIO[Long]
val getOID: LargeObjectIO[Int]
val getOutputStream: LargeObjectIO[OutputStream]
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]): ~>[LargeObjectOp, [γ$0$]Kleisli[M, LargeObject, γ$0$]]

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

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def read(a: Array[Byte], b: Int, c: Int): LargeObjectIO[Int]
def read(a: Int): LargeObjectIO[Array[Byte]]
def seek(a: Int, b: Int): LargeObjectIO[Unit]
def seek(a: Int): LargeObjectIO[Unit]
val size: LargeObjectIO[Int]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
val tell: LargeObjectIO[Int]
def toString(): String

Definition Classes
AnyRef → Any
def truncate(a: Int): LargeObjectIO[Unit]
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 write(a: Array[Byte]): LargeObjectIO[Unit]
def write(a: Array[Byte], b: Int, c: Int): LargeObjectIO[Unit]

Related Doc: package free

object largeobject extends LargeObjectIOInstances

Type Members

type LargeObjectIO[A] = Free[LargeObjectOp, A]

implicit class LargeObjectIOOps[A] extends AnyRef

sealed trait LargeObjectOp[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit val CaptureLargeObjectIO: Capture[LargeObjectIO]

implicit val CatchableLargeObjectIO: Catchable[LargeObjectIO]

object LargeObjectOp

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

val close: LargeObjectIO[Unit]

val copy: LargeObjectIO[LargeObject]

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

val getInputStream: LargeObjectIO[InputStream]

val getLongOID: LargeObjectIO[Long]

val getOID: LargeObjectIO[Int]

val getOutputStream: LargeObjectIO[OutputStream]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def read(a: Array[Byte], b: Int, c: Int): LargeObjectIO[Int]

def read(a: Int): LargeObjectIO[Array[Byte]]

def seek(a: Int, b: Int): LargeObjectIO[Unit]

def seek(a: Int): LargeObjectIO[Unit]

val size: LargeObjectIO[Int]

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

val tell: LargeObjectIO[Int]

def toString(): String

def truncate(a: Int): LargeObjectIO[Unit]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

def write(a: Array[Byte]): LargeObjectIO[Unit]

def write(a: Array[Byte], b: Int, c: Int): LargeObjectIO[Unit]

Inherited from LargeObjectIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped