trait SchemaCompanionMacros extends SchemaMagnoliaDerivation
- Alphabetic
- By Inheritance
- SchemaCompanionMacros
- SchemaMagnoliaDerivation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type Typeclass[T] = Schema[T]
- Definition Classes
- SchemaMagnoliaDerivation
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def combine[T](ctx: ReadOnlyCaseClass[Schema, T])(implicit genericDerivationConfig: Configuration): Schema[T]
- Definition Classes
- SchemaMagnoliaDerivation
- macro def derived[T]: Schema[T]
- 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 beobject
s.Because of technical limitations of macros, the customisation arguments can't be given here directly, instead being delegated to CreateDerivedEnumerationSchema.
- def dispatch[T](ctx: SealedTrait[Schema, T])(implicit genericDerivationConfig: Configuration): Schema[T]
- Definition Classes
- SchemaMagnoliaDerivation
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- macro def oneOfUsingField[E, V](extractor: (E) => V, asString: (V) => String)(mapping: (V, Schema[_])*)(implicit conf: Configuration): Schema[E]
- 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)
- implicit macro def schemaForMap[V](implicit arg0: Schema[V]): Schema[Map[String, V]]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated