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.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Concatenates two set of hints. The levels are concatenated independently.
Concatenates two set of hints. The levels are concatenated independently.
Attributes
Add hints to the member-level.
Add hints to the member-level.
Attributes
Add hints to the target-level.
Add hints to the target-level.
Attributes
Provides an instance of hints containing only the member-level hints.
Provides an instance of hints containing only the member-level hints.
Attributes
Provides an instance of hints containing only the target-level hints.
Provides an instance of hints containing only the target-level hints.
Attributes
Concrete methods
Add hints to the member-level.
Add hints to the member-level.
Attributes
Add hints to the target-level.
Add hints to the target-level.