Object

doobie.postgres.free

copyout

Related Doc: package free

Permalink

object copyout extends CopyOutIOInstances

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

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

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

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

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)
Source
copyout.scala
Linear Supertypes
CopyOutIOInstances, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. copyout
  2. CopyOutIOInstances
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type CopyOutIO[A] = Free[CopyOutOp, A]

    Permalink

    Free monad over a free functor of CopyOutOp; abstractly, a computation that consumes a org.postgresql.copy.CopyOut and produces a value of type A.

  2. implicit class CopyOutIOOps[A] extends AnyRef

    Permalink

    Syntax for CopyOutIO.

  3. sealed trait CopyOutOp[A] extends AnyRef

    Permalink

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

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 CaptureCopyOutIO: Capture[CopyOutIO]

    Permalink

    Capture instance for CopyOutIO.

  5. implicit val CatchableCopyOutIO: Catchable[CopyOutIO]

    Permalink

    Catchable instance for CopyOutIO.

  6. object CopyOutOp

    Permalink

    Module of constructors for CopyOutOp.

    Module of constructors for CopyOutOp. These are rarely useful outside of the implementation; prefer the smart constructors provided by the copyout module.

  7. final def asInstanceOf[T0]: T0

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

    Permalink

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

  9. val cancelCopy: CopyOutIO[Unit]

    Permalink

  10. def clone(): AnyRef

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

    Permalink

    Non-strict unit for capturing effects.

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. val getFieldCount: CopyOutIO[Int]

    Permalink

  17. def getFieldFormat(a: Int): CopyOutIO[Int]

    Permalink

  18. val getFormat: CopyOutIO[Int]

    Permalink

  19. val getHandledRowCount: CopyOutIO[Long]

    Permalink

  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. val isActive: CopyOutIO[Boolean]

    Permalink

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[CopyOutOp, [γ$0$]Kleisli[M, CopyOut, γ$0$]]

    Permalink

    Natural transformation from CopyOutOp to Kleisli for the given M, consuming a org.postgresql.copy.CopyOut.

  24. def liftCopyIn[A](s: CopyIn, k: CopyInIO[A]): CopyOutIO[A]

    Permalink

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

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

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

    Permalink
    Definition Classes
    AnyRef
  28. val readFromCopy: CopyOutIO[Array[Byte]]

    Permalink

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from CopyOutIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped