Nestru.PreDecoder protocol (Nestru v0.1.0) View Source
Link to this section Summary
Functions
Returns fields map to be decoded into the struct adopting the protocol.
Link to this section Types
Specs
t() :: term()
Link to this section Functions
Returns fields map to be decoded into the struct adopting the protocol.
Nestru
calls this function as the first step of the decoding procedure.
Useful when the input map should be changed to match the field names
of the struct.
The first argument is an empty struct value adopting the protocol.
The second argument is the context value given to the Nestru.from_map/3
function call.
The third argument is a map given to the Nestru.from_map/3
function call.
If the function returns {:ok, map}
then the map
will be decoded into the struct.
If the function returns {:error, message}
tuple, then decoding stops, and
the error is bypassed to the caller.
Any other return value raises an error.
The default implementation returns the input map unmodified.