Hints

smithy4s.Hints
See theHints companion object
trait Hints

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.

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Abstract methods

def ++(other: Hints): Hints
def get[A](implicit key: ShapeTag[A]): Option[A]

Concrete methods

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