final case class MapSchema[K, V](shapeId: ShapeId, hints: Hints, key: Schema[K], value: Schema[V]) extends Schema[Map[K, V]] with Product with Serializable
- Alphabetic
- By Inheritance
- MapSchema
- Serializable
- Product
- Equals
- Schema
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
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[Map[K, V]]
- Definition Classes
- Schema
- final def addHints(hints: Hint*): Schema[Map[K, V]]
- Definition Classes
- Schema
- final def addMemberHints(hints: Hints): Schema[Map[K, V]]
- Definition Classes
- Schema
- final def addMemberHints(hints: Hint*): Schema[Map[K, V]]
- Definition Classes
- Schema
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def biject[B](to: (Map[K, V]) => B)(from: (B) => Map[K, V]): Schema[B]
- Definition Classes
- Schema
- final def biject[B](bijection: Bijection[Map[K, V], B]): Schema[B]
- Definition Classes
- Schema
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def compile[F[_]](fk: ~>[Schema, F]): F[Map[K, V]]
- Definition Classes
- Schema
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def error(unlift: (Map[K, V]) => Throwable)(lift: PartialFunction[Throwable, Map[K, V]]): ErrorSchema[Map[K, V]]
Turns this schema into an error schema.
Turns this schema into an error schema.
- Definition Classes
- Schema
- final def field[Struct]: PartiallyAppliedField[Struct, Map[K, V]]
- Definition Classes
- Schema
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def findPayload(find: (Field[_, _]) => Boolean): SchemaPartition[Map[K, V]]
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.
- Definition Classes
- Schema
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def getDefault: Option[Document]
- Definition Classes
- Schema
- final def getDefaultValue: Option[Map[K, V]]
- Definition Classes
- Schema
- val hints: Hints
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def isOption: Boolean
- Definition Classes
- Schema
- 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.
Finds whether a schema (or the underlying schema in the case of bijections/surjections, etc) is a primitive of a certain type.
- Definition Classes
- Schema
- final def isUnit: Boolean
Checks whether a schema is Unit or an empty structure
Checks whether a schema is Unit or an empty structure
- Definition Classes
- Schema
- val key: Schema[K]
- 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 nullable: Schema[Nullable[Map[K, V]]]
- Definition Classes
- Schema
- final def oneOf[Union]: PartiallyAppliedOneOf[Union, Map[K, V]]
- Definition Classes
- Schema
- final def option: Schema[Option[Map[K, V]]]
- Definition Classes
- Schema
- final def optional[Struct]: PartiallyAppliedOptional[Struct, Map[K, V]]
- Definition Classes
- Schema
- final def partition(filter: (Field[_, _]) => Boolean): SchemaPartition[Map[K, V]]
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
- Definition Classes
- Schema
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- final def refined[B]: PartiallyAppliedRefinement[Map[K, V], B]
- Definition Classes
- Schema
- final def required[Struct]: PartiallyAppliedRequired[Struct, Map[K, V]]
- Definition Classes
- Schema
- val shapeId: ShapeId
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- final def transformHintsLocally(f: (Hints) => Hints): Schema[Map[K, V]]
- Definition Classes
- Schema
- final def transformHintsTransitively(f: (Hints) => Hints): Schema[Map[K, V]]
- Definition Classes
- Schema
- def transformTransitivelyK(f: ~>[Schema, Schema]): Schema[Map[K, V]]
- Definition Classes
- Schema
- final def validated[C](c: C)(implicit constraint: Simple[C, Map[K, V]]): Schema[Map[K, V]]
- Definition Classes
- Schema
- val value: Schema[V]
- 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[Map[K, V]]
- Definition Classes
- Schema
- final def withId(newId: ShapeId): Schema[Map[K, V]]
- Definition Classes
- Schema