doobie.postgres.free

largeobjectmanager

object largeobjectmanager extends LargeObjectManagerIOInstances

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

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

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

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

// Unfolding into a Task
val ta: Task[A] = a.transK[Task].run(s)
Source
largeobjectmanager.scala
Linear Supertypes
LargeObjectManagerIOInstances, AnyRef, Any
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. largeobjectmanager
  2. LargeObjectManagerIOInstances
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. type LargeObjectManagerIO[A] = Free[LargeObjectManagerOp, A]

    Free monad over a free functor of LargeObjectManagerOp; abstractly, a computation that consumes a org.postgresql.largeobject.LargeObjectManager and produces a value of type A.

  2. implicit class LargeObjectManagerIOOps[A] extends AnyRef

    Syntax for LargeObjectManagerIO.

  3. sealed trait LargeObjectManagerOp[A] extends AnyRef

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

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. implicit val CaptureLargeObjectManagerIO: Capture[LargeObjectManagerIO]

    Capture instance for LargeObjectManagerIO.

  7. implicit val CatchableLargeObjectManagerIO: Catchable[LargeObjectManagerIO]

    Catchable instance for LargeObjectManagerIO.

  8. object LargeObjectManagerOp

    Module of constructors for LargeObjectManagerOp.

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def attempt[A](a: LargeObjectManagerIO[A]): LargeObjectManagerIO[\/[Throwable, A]]

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

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. def createLO(a: Int): LargeObjectManagerIO[Long]

  13. val createLO: LargeObjectManagerIO[Long]

  14. def delay[A](a: ⇒ A): LargeObjectManagerIO[A]

    Non-strict unit for capturing effects.

  15. def delete(a: Long): LargeObjectManagerIO[Unit]

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

    Definition Classes
    AnyRef

  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  20. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  22. def kleisliTrans[M[_]](implicit arg0: Monad[M], arg1: Catchable[M], arg2: Capture[M]): ~>[LargeObjectManagerOp, [γ$0$]Kleisli[M, LargeObjectManager, γ$0$]]

    Natural transformation from LargeObjectManagerOp to Kleisli for the given M, consuming a org.postgresql.largeobject.LargeObjectManager.

  23. def liftLargeObject[A](s: LargeObject, action: LargeObjectIO[A]): LargeObjectManagerIO[A]

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

    Definition Classes
    AnyRef

  25. final def notify(): Unit

    Definition Classes
    AnyRef

  26. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  27. def open(a: Long): LargeObjectManagerIO[LargeObject]

  28. def open(a: Long, b: Int): LargeObjectManagerIO[LargeObject]

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

    Definition Classes
    AnyRef

  30. def toString(): String

    Definition Classes
    AnyRef → Any

  31. def unlink(a: Long): LargeObjectManagerIO[Unit]

  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from LargeObjectManagerIOInstances

Inherited from AnyRef

Inherited from Any

Algebra

Constructors (Lifting)

Constructors (Primitives)

Typeclass Instances

Ungrouped