Construct that expresses the ability to decode an http message, the metadata of which will have already been decoded and staged in a Map[String, Any] indexed by field.
On the encoding side, the fields that should be stored in metadata are eluded.
- Companion:
- object
Value members
Concrete methods
Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException
error if the JSON input does not encode a value of this type.
Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException
error if the JSON input does not encode a value of this type.
- Value parameters:
- default
the placeholder value provided to initialize some possible local variables
- in
an instance of
JsonReaderwhich provide an access to the JSON input to parse a JSON value to value of typeA
- Definition Classes
- JsonValueCodec
States whether this codec expects data from the body of an http request (as opposed to from headers, query params, etc). Used to prevent parsing altogether when not required.
States whether this codec expects data from the body of an http request (as opposed to from headers, query params, etc). Used to prevent parsing altogether when not required.
Returns some placeholder value that will be used by the high level code that generates codec instances to
initialize local variables for parsed field values which have a codec that was injected using implicit val.
Returns some placeholder value that will be used by the high level code that generates codec instances to
initialize local variables for parsed field values which have a codec that was injected using implicit val.
See the jsoniter-scala-macros sub-project code and its tests for usages of .nullValue calls.
- Definition Classes
- JsonValueCodec
Inherited methods
Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException
error if the JSON input is not a key or does not encode a value of this type.
Attempts to decode a value of type A from the specified JsonReader, but may fail with JsonReaderException
error if the JSON input is not a key or does not encode a value of this type.
- Value parameters:
- in
an instance of
JsonReaderwhich provide an access to the JSON input to parse a JSON key to value of typeA
- Inherited from:
- JsonKeyCodec
Encodes the specified value using provided JsonWriter as a JSON key, but may fail with JsonWriterException if
it cannot be encoded properly according to RFC-8259 requirements.
Encodes the specified value using provided JsonWriter as a JSON key, but may fail with JsonWriterException if
it cannot be encoded properly according to RFC-8259 requirements.
- Value parameters:
- out
an instance of
JsonWriterwhich provides access to JSON output to serialize the specified value as a JSON key- x
the value provided for serialization
- Inherited from:
- JsonKeyCodec
Encodes the specified value using provided JsonWriter, but may fail with JsonWriterException if it cannot be
encoded properly according to RFC-8259 requirements.
Encodes the specified value using provided JsonWriter, but may fail with JsonWriterException if it cannot be
encoded properly according to RFC-8259 requirements.
- Value parameters:
- out
an instance of
JsonWriterwhich provides access to JSON output to serialize the specified value as a JSON value- x
the value provided for serialization
- Inherited from:
- JsonValueCodec