Packages

  • package root
    Definition Classes
    root
  • package endpoints
    Definition Classes
    root
  • package generic
    Definition Classes
    endpoints
  • trait JsonSchemas extends algebra.JsonSchemas

    Enriches JsonSchemas with two kinds of operations:

    Enriches JsonSchemas with two kinds of operations:

    • genericJsonSchema[A] derives the JsonSchema of an algebraic data type A;
    • (field1 :×: field2 :×: …).as[A] builds a tuple of Records and maps it to a case class A

    For instance, consider the following program that derives the JSON schema of a case class:

    case class User(name: String, age: Int)
    object User {
      implicit val schema: JsonSchema[User] = genericJsonSchema[User]
    }

    It is equivalent to the following:

    case class User(name: String, age: Int)
    object User {
      implicit val schema: JsonSchema[User] = (
        field[String]("name") zip
        field[Int]("age")
      ).xmap((User.apply _).tupled)(Function.unlift(User.unapply))
    }
    Definition Classes
    generic
  • trait GenericDescriptions extends AnyRef

    Internal machinery for extracting a description of a type

    Internal machinery for extracting a description of a type

    Definition Classes
    JsonSchemas
  • GenericDescription
  • GenericDescriptionLowPriority

class GenericDescription[A] extends AnyRef

Source
JsonSchemas.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GenericDescription
  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 GenericDescription(description: Option[String])

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): (GenericDescription[A], B)
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toArrowAssoc[GenericDescription[A]] 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]) @native()
  7. val description: Option[String]
  8. def ensuring(cond: (GenericDescription[A]) => Boolean, msg: => Any): GenericDescription[A]
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toEnsuring[GenericDescription[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (GenericDescription[A]) => Boolean): GenericDescription[A]
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toEnsuring[GenericDescription[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): GenericDescription[A]
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toEnsuring[GenericDescription[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): GenericDescription[A]
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toEnsuring[GenericDescription[A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toStringFormat[GenericDescription[A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  23. def toString(): String
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def [B](y: B): (GenericDescription[A], B)
    Implicit
    This member is added by an implicit conversion from GenericDescription[A] toArrowAssoc[GenericDescription[A]] 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 fromGenericDescription[A] to StringFormat[GenericDescription[A]]

Inherited by implicit conversion Ensuring fromGenericDescription[A] to Ensuring[GenericDescription[A]]

Inherited by implicit conversion ArrowAssoc fromGenericDescription[A] to ArrowAssoc[GenericDescription[A]]

Ungrouped