object Schema extends LowPrioritySchema with SchemaCompanionMacros with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Schema
  2. Serializable
  3. SchemaCompanionMacros
  4. SchemaMagnoliaDerivation
  5. LowPrioritySchema
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class SName(fullName: String, typeParameterShortNames: List[String] = Nil) extends Product with Serializable
  2. type Typeclass[T] = Schema[T]
    Definition Classes
    SchemaMagnoliaDerivation

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val ModifyCollectionElements: String
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def binary[T]: Schema[T]

    Creates a schema for type T, where the low-level representation is binary.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. def combine[T](ctx: ReadOnlyCaseClass[Schema, T])(implicit genericDerivationConfig: Configuration): Schema[T]
    Definition Classes
    SchemaMagnoliaDerivation
  9. macro def derived[T]: Schema[T]
    Definition Classes
    SchemaCompanionMacros
  10. macro def derivedEnumeration[T]: CreateDerivedEnumerationSchema[T]

    Creates a schema for an enumeration, where the validator is derived using sttp.tapir.Validator.derivedEnumeration.

    Creates a schema for an enumeration, where the validator is derived using sttp.tapir.Validator.derivedEnumeration. This requires that all subtypes of the sealed hierarchy T must be objects.

    Because of technical limitations of macros, the customisation arguments can't be given here directly, instead being delegated to CreateDerivedEnumerationSchema.

    Definition Classes
    SchemaCompanionMacros
  11. implicit def derivedSchema[T](implicit derived: Derived[Schema[T]]): Schema[T]
    Definition Classes
    LowPrioritySchema
  12. def dispatch[T](ctx: SealedTrait[Schema, T])(implicit genericDerivationConfig: Configuration): Schema[T]
    Definition Classes
    SchemaMagnoliaDerivation
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. macro def oneOfUsingField[E, V](extractor: (E) => V, asString: (V) => String)(mapping: (V, Schema[_])*)(implicit conf: Configuration): Schema[E]
    Definition Classes
    SchemaCompanionMacros
  22. implicit def schemaForArray[T](implicit arg0: Schema[T]): Schema[Array[T]]
  23. implicit val schemaForBigDecimal: Schema[BigDecimal]
  24. implicit val schemaForBigInt: Schema[BigInt]
  25. implicit val schemaForBoolean: Schema[Boolean]
  26. implicit val schemaForByte: Schema[Byte]
  27. implicit val schemaForByteArray: Schema[Array[Byte]]
  28. implicit val schemaForByteBuffer: Schema[ByteBuffer]
  29. implicit val schemaForDate: Schema[Date]
  30. implicit val schemaForDouble: Schema[Double]
  31. implicit def schemaForEither[A, B](implicit sa: Schema[A], sb: Schema[B]): Schema[Either[A, B]]
  32. implicit val schemaForFile: Schema[tapir.TapirFile]
  33. implicit val schemaForFileRange: Schema[FileRange]
  34. implicit val schemaForFloat: Schema[Float]
  35. implicit val schemaForInputStream: Schema[InputStream]
  36. implicit val schemaForInstant: Schema[Instant]
  37. implicit val schemaForInt: Schema[Int]
  38. implicit def schemaForIterable[T, C[X] <: Iterable[X]](implicit arg0: Schema[T]): Schema[C[T]]
  39. implicit val schemaForJBigDecimal: Schema[BigDecimal]
  40. implicit val schemaForJBigInteger: Schema[BigInteger]
  41. implicit val schemaForJavaDuration: Schema[Duration]
  42. implicit val schemaForLocalDate: Schema[LocalDate]
  43. implicit val schemaForLocalDateTime: Schema[LocalDateTime]
  44. implicit val schemaForLocalTime: Schema[LocalTime]
  45. implicit val schemaForLong: Schema[Long]
  46. macro def schemaForMap[K, V](keyToString: (K) => String)(implicit arg0: Schema[K], arg1: Schema[V]): Schema[Map[K, V]]

    Create a schema for a map with arbitrary keys.

    Create a schema for a map with arbitrary keys. The schema for the keys (Schema[K]) should be a string (that is, the schema type should be sttp.tapir.SchemaType.SString), however this cannot be verified at compile-time and is not verified at run-time.

    The given keyToString conversion function is used during validation.

    If you'd like this schema to be available as an implicit for a given type of keys, create an custom implicit, e.g.:

    case class MyKey(value: String) extends AnyVal
implicit val schemaForMyMap = Schema.schemaForMap[MyKey, MyValue](_.value)
    Definition Classes
    SchemaCompanionMacros
  47. implicit macro def schemaForMap[V](implicit arg0: Schema[V]): Schema[Map[String, V]]
    Definition Classes
    SchemaCompanionMacros
  48. implicit val schemaForOffsetDateTime: Schema[OffsetDateTime]
  49. implicit val schemaForOffsetTime: Schema[OffsetTime]
  50. implicit def schemaForOption[T](implicit arg0: Schema[T]): Schema[Option[T]]
  51. implicit def schemaForPart[T](implicit arg0: Schema[T]): Schema[Part[T]]
  52. implicit val schemaForScalaDuration: Schema[Duration]
  53. implicit val schemaForShort: Schema[Short]
  54. implicit val schemaForString: Schema[String]
  55. implicit val schemaForUUID: Schema[UUID]
  56. implicit val schemaForUnit: Schema[Unit]
  57. implicit val schemaForZoneOffset: Schema[ZoneOffset]
  58. implicit val schemaForZonedDateTime: Schema[ZonedDateTime]
  59. def string[T]: Schema[T]

    Creates a schema for type T, where the low-level representation is a String.

  60. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  61. def toString(): String
    Definition Classes
    AnyRef → Any
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  64. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  65. object SName extends Serializable
  66. object annotations

    Annotations which are used during automatic schema derivation, or semi-automatic schema derivation using Schema.derived.

Deprecated Value Members

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

Inherited from Serializable

Inherited from SchemaCompanionMacros

Inherited from SchemaMagnoliaDerivation

Inherited from LowPrioritySchema

Inherited from AnyRef

Inherited from Any

Ungrouped