Hints

trait Hints

A hing 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.

Companion
object
class Object
trait Matchable
class Any

Value members

Abstract methods

def ++(other: Hints): Hints
def all: Iterable[Binding[_]]
def get[A](implicit key: Key[A]): Option[A]
def isEmpty: Boolean
def toMap: Map[Key[_], Hint]

Concrete methods

final
def get[A](key: Has[A]): Option[A]
final
def get[T](nt: Newtype[T]): Option[Type]