sealed trait Schema[A] extends AnyRef
- Alphabetic
- By Inheritance
- Schema
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Concrete 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 addHints(hints: Hints): Schema[A]
- final def addHints(hints: Hint*): Schema[A]
- final def addMemberHints(hints: Hints): Schema[A]
- final def addMemberHints(hints: Hint*): Schema[A]
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def biject[B](to: (A) => B)(from: (B) => A): Schema[B]
- final def biject[B](bijection: Bijection[A, B]): Schema[B]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def compile[F[_]](fk: ~>[Schema, F]): F[A]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def error(unlift: (A) => Throwable)(lift: PartialFunction[Throwable, A]): ErrorSchema[A]
Turns this schema into an error schema.
- final def field[Struct]: PartiallyAppliedField[Struct, A]
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def findPayload(find: (Field[_, _]) => Boolean): SchemaPartition[A]
Finds the first field that matches the criteria used, and applies a bijection between the schema it holds and partial data, which ensures for the field's schema to be used as "top level" when decoding "payloads".
Finds the first field that matches the criteria used, and applies a bijection between the schema it holds and partial data, which ensures for the field's schema to be used as "top level" when decoding "payloads".
NB : a "payload" is typically a whole set of data, without a typical field-based splitting into subparts. This can be, for instance, an http body.
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def getDefault: Option[Document]
- final def getDefaultValue: Option[A]
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isOption: Boolean
- final def isPrimitive[P](prim: Primitive[P]): Boolean
Finds whether a schema (or the underlying schema in the case of bijections/surjections, etc) is a primitive of a certain type.
- final def isUnit: Boolean
Checks whether a schema is Unit or an empty structure
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def oneOf[Union]: PartiallyAppliedOneOf[Union, A]
- final def option: Schema[Option[A]]
- final def optional[Struct]: PartiallyAppliedOptional[Struct, A]
- final def partition(filter: (Field[_, _]) => Boolean): SchemaPartition[A]
When applied on a structure schema, creates a schema that, when compiled into a codec, will only encode/decode a subset of the data, based on the hints of each field.
When applied on a structure schema, creates a schema that, when compiled into a codec, will only encode/decode a subset of the data, based on the hints of each field.
This can be used to only encode some fields of the data into the http body
Returns a SchemaPartition that indicates whether : * no field match the condition * some fields match the condition * all fields match the condition
- final def refined[B]: PartiallyAppliedRefinement[A, B]
- final def required[Struct]: PartiallyAppliedRequired[Struct, A]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def transformHintsLocally(f: (Hints) => Hints): Schema[A]
- final def transformHintsTransitively(f: (Hints) => Hints): Schema[A]
- final def validated[C](c: C)(implicit constraint: Simple[C, A]): Schema[A]
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- 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 withId(namespace: String, name: String): Schema[A]
- final def withId(newId: ShapeId): Schema[A]