blob

Algebra and free monad for primitive operations over a java.sql.Blob. 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.

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

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

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

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

Source: blob.scala

Linear Supertypes

AnyRef, Any

Type Members

type BlobIO[A] = Free[BlobOp, A]

Free monad over a free functor of BlobOp; abstractly, a computation that consumes a java.sql.Blob and produces a value of type A.
implicit class BlobIOOps[A] extends AnyRef

Syntax for BlobIO.
sealed trait BlobOp[A] extends AnyRef

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

Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

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

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
object BlobOp

Module of constructors for BlobOp.
implicit val CaptureBlobIO: Capture[BlobIO]

Capture instance for BlobIO.
implicit val CatchableBlobIO: Catchable[BlobIO]

Catchable instance for BlobIO.
final def asInstanceOf[T0]: T0

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

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

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def delay[A](a: ⇒ A): BlobIO[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] )
val free: BlobIO[Unit]
def getBinaryStream(a: Long, b: Long): BlobIO[InputStream]
val getBinaryStream: BlobIO[InputStream]
def getBytes(a: Long, b: Int): BlobIO[Array[Byte]]
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobOp, [γ]Kleisli[M, Blob, γ]]

Natural transformation from BlobOp to Kleisli for the given M, consuming a java.sql.Blob.
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
val length: BlobIO[Long]
def lift[Op[_], A, J](j: J, action: Free[Op, A])(implicit mod: Aux[Op, J]): BlobIO[A]

Lift a different type of program that has a default Kleisli interpreter.
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def position(a: Array[Byte], b: Long): BlobIO[Long]
def position(a: Blob, b: Long): BlobIO[Long]
def raw[A](f: (Blob) ⇒ A): BlobIO[A]

Backdoor for arbitrary computations on the underlying Blob.
def setBinaryStream(a: Long): BlobIO[OutputStream]
def setBytes(a: Long, b: Array[Byte]): BlobIO[Int]
def setBytes(a: Long, b: Array[Byte], c: Int, d: Int): BlobIO[Int]
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
def trans[M[_]](c: Blob)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobIO, M]

Natural transformation from BlobIO to M, given a java.sql.Blob.
def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobIO, [γ]Kleisli[M, Blob, γ]]

Natural transformation from BlobIO to Kleisli for the given M, consuming a java.sql.Blob.
def truncate(a: Long): BlobIO[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( ... )

object blob

Type Members

type BlobIO[A] = Free[BlobOp, A]

implicit class BlobIOOps[A] extends AnyRef

sealed trait BlobOp[A] extends AnyRef

Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

object BlobOp

implicit val CaptureBlobIO: Capture[BlobIO]

implicit val CatchableBlobIO: Catchable[BlobIO]

final def asInstanceOf[T0]: T0

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

def clone(): AnyRef

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

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

val free: BlobIO[Unit]

def getBinaryStream(a: Long, b: Long): BlobIO[InputStream]

val getBinaryStream: BlobIO[InputStream]

def getBytes(a: Long, b: Int): BlobIO[Array[Byte]]

final def getClass(): Class[_]

def hashCode(): Int

def interpK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobOp, [γ]Kleisli[M, Blob, γ]]

final def isInstanceOf[T0]: Boolean

val length: BlobIO[Long]

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

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def position(a: Array[Byte], b: Long): BlobIO[Long]

def position(a: Blob, b: Long): BlobIO[Long]

def raw[A](f: (Blob) ⇒ A): BlobIO[A]

def setBinaryStream(a: Long): BlobIO[OutputStream]

def setBytes(a: Long, b: Array[Byte]): BlobIO[Int]

def setBytes(a: Long, b: Array[Byte], c: Int, d: Int): BlobIO[Int]

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

def toString(): String

def trans[M[_]](c: Blob)(implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobIO, M]

def transK[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[BlobIO, [γ]Kleisli[M, Blob, γ]]

def truncate(a: Long): BlobIO[Unit]

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped