An abstraction exposing serialisation functions to decode from bytes / encode to bytes, based on a path-dependant Codec types.
Only used in unary request/response patterns.
Attributes
- Companion:
- object
- Graph
- Supertypes
- class Objecttrait Matchableclass Any
- Known subtypes
- class DelegatingCodecAPI
Members list
Value members
Abstract methods
Turns a Schema into this API's preferred representation.
Turns a Schema into this API's preferred representation.
Attributes
- cache
a Cache that can be used to optimise the compilation of Schemas into Codecs.
- schema
the value's schema
- Returns:
the codec associated to the A value.
Decodes partial data from a byte array
Decodes partial data from a byte array
Attributes
- bytes
an byte array
- codec
the implementation-specific codec type
- Returns:
either a PayloadError, or the partial data, which can be combined with partial data coming from the metadata.
Decodes partial data from a byte buffer, returning a function that is able to reconstruct the full data, provided a map resulting from the decoding of the metadata.
Decodes partial data from a byte buffer, returning a function that is able to reconstruct the full data, provided a map resulting from the decoding of the metadata.
Attributes
- bytes
a bytue buffer
- codec
the implementation-specific codec
- Returns:
either a PayloadError, or the partial data, which can be combined with partial data coming from the metadata.
Writes data to a byte array. Field values bound to http metadata (path/query/headers) must be eluded.
Writes data to a byte array. Field values bound to http metadata (path/query/headers) must be eluded.
Attributes
- codec
the implementation-specific codec
- value
the value to encode
Concrete methods
Turns a Schema into this API's preferred representation.
Turns a Schema into this API's preferred representation.
Attributes
- schema
the value's schema
- Returns:
the codec associated to the A value.