KiwiCodec.RustlerGenerator.Field (kiwi_codec v0.7.0)

How a generated decoder reads or skips a schema field: once, repeated for an array, or as a whole byte array for byte[].

Summary

Whether a field reads repeated, and the function reading one value of it as a term, with decoder naming a definition's decoder.

Whether a field skips repeated or as bytes, and the function skipping one value.

A field's row for a skip decoder: how to skip it.

A field's rows for a sparse decoder: id, key, and how to read it.

@spec read(map(), (String.t() -> atom())) :: {boolean(), atom()}

Whether a field reads repeated, and the function reading one value of it as a term, with decoder naming a definition's decoder.

@spec skip(map(), map()) :: {boolean(), boolean(), atom()}

Whether a field skips repeated or as bytes, and the function skipping one value.

@spec skip_row(map(), map()) :: keyword()

A field's row for a skip decoder: how to skip it.

@spec sparse_row(map()) :: keyword()

A field's rows for a sparse decoder: id, key, and how to read it.