Packages

abstract class Shape[Level <: ShapeLevel, -Mixed_, Unpacked_, Packed_] extends AnyRef

A type class that encodes the unpacking Mixed => Unpacked of a Query[Mixed] to its result element type Unpacked and the packing to a fully packed type Packed, i.e. a type where everything which is not a transparent container is wrapped in a Column[_].

Example:

  • Mixed: (Column[Int], Column[(Int, String)], (Int, Option[Double]))
  • Unpacked: (Int, (Int, String), (Int, Option[Double]))
  • Packed: (Column[Int], Column[(Int, String)], (Column[Int], Column[Option[Double]]))
  • Linearized: (Int, Int, String, Int, Option[Double])
Annotations
@implicitNotFound()
Source
Shape.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
HListShape, CaseClassShape, MappedProductShape, MappedScalaProductShape, ProductClassShape, ProductNodeShape, RepShape, TupleShape
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Shape
  2. AnyRef
  3. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Shape()

Type Members

  1. type Mixed = Mixed_
  2. type Packed = Packed_
  3. type Unpacked = Unpacked_

Abstract Value Members

  1. abstract def buildParams(extract: (Any) => Unpacked): Packed

    Build a packed representation containing QueryParameters that can extract data from the unpacked representation later.

    Build a packed representation containing QueryParameters that can extract data from the unpacked representation later. This method is not available for shapes where Mixed and Unpacked are different types.

  2. abstract def encodeRef(value: Any, path: Node): Any

    Encode a reference into a value of this Shape.

    Encode a reference into a value of this Shape. This method may not be available for shapes where Mixed and Packed are different types.

  3. abstract def pack(value: Any): Packed

    Convert a value of this Shape's (mixed) type to the fully packed type

  4. abstract def packedShape: Shape[Level, Packed, Unpacked, Packed]

    Return the fully packed Shape

  5. abstract def toNode(value: Any): Node

    Return an AST Node representing a mixed value.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Shape[Level, Mixed_, Unpacked_, Packed_], B)
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toArrowAssoc[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  7. def ensuring(cond: (Shape[Level, Mixed_, Unpacked_, Packed_]) => Boolean, msg: => Any): Shape[Level, Mixed_, Unpacked_, Packed_]
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toEnsuring[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  8. def ensuring(cond: (Shape[Level, Mixed_, Unpacked_, Packed_]) => Boolean): Shape[Level, Mixed_, Unpacked_, Packed_]
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toEnsuring[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: Boolean, msg: => Any): Shape[Level, Mixed_, Unpacked_, Packed_]
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toEnsuring[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean): Shape[Level, Mixed_, Unpacked_, Packed_]
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toEnsuring[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. def toString(): String
    Definition Classes
    AnyRef → Any
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  23. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toStringFormat[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def →[B](y: B): (Shape[Level, Mixed_, Unpacked_, Packed_], B)
    Implicit
    This member is added by an implicit conversion from Shape[Level, Mixed_, Unpacked_, Packed_] toArrowAssoc[Shape[Level, Mixed_, Unpacked_, Packed_]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromShape[Level, Mixed_, Unpacked_, Packed_] to StringFormat[Shape[Level, Mixed_, Unpacked_, Packed_]]

Inherited by implicit conversion Ensuring fromShape[Level, Mixed_, Unpacked_, Packed_] to Ensuring[Shape[Level, Mixed_, Unpacked_, Packed_]]

Inherited by implicit conversion ArrowAssoc fromShape[Level, Mixed_, Unpacked_, Packed_] to ArrowAssoc[Shape[Level, Mixed_, Unpacked_, Packed_]]

Ungrouped