trait Hints extends AnyRef
A hint is an arbitrary piece of data that can be added to a schema, at the struct level, or at the field/member level.
You can think of it as an annotation that can communicate additional information to encoders/decoders (for instance, a change in a label, a regex pattern some string should abide by, a range, etc)
This Hints interface is a container for hints.
Under the hood, the hints are composed of two maps : one for member-level hints, one for target-level hints. Member-level hints typically hold values corresponding to member traits, whereas target hints hold values corresponding to normal data shapes.
- Alphabetic
- By Inheritance
- Hints
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def ++(other: Hints): Hints
Concatenates two set of hints.
Concatenates two set of hints. The levels are concatenated independently.
- abstract def addMemberHints(hints: Hints): Hints
Add hints to the member-level.
- abstract def addTargetHints(hints: Hints): Hints
Add hints to the target-level.
- abstract def all: Iterable[Binding]
- abstract def get[A](implicit key: ShapeTag[A]): Option[A]
- abstract def isEmpty: Boolean
- abstract def memberHints: Hints
Provides an instance of hints containing only the member-level hints.
- abstract def memberHintsMap: Map[ShapeId, Binding]
- abstract def targetHints: Hints
Provides an instance of hints containing only the target-level hints.
- abstract def targetHintsMap: Map[ShapeId, Binding]
- abstract def toMap: Map[ShapeId, Binding]
Returns a map of hints from both level, the member-level having priority over the target-level one.
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 add(hints: Hint*): Hints
Add hints to the member level
- final def addMemberHints(hints: Hint*): Hints
Add hints to the member-level.
- final def addTargetHints(hints: Hint*): Hints
Add hints to the target-level.
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def expand[A, B](f: (A) => Hint)(implicit key: ShapeTag[A]): Hints
Adds a new hint provided a specific hint is present
- final def filter(predicate: (Hint) => Boolean): Hints
- final def filterNot(predicate: (Hint) => Boolean): Hints
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def get[T](nt: Newtype[T]): Option[Type]
- final def get[A](key: Has[A]): Option[A]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def has[A](implicit key: ShapeTag[A]): Boolean
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- 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()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()