View Source argo_header (argo v1.0.3)
Summary
Types
-type options() ::
#{inline_everything => boolean(),
self_describing => boolean(),
out_of_band_field_errors => boolean(),
self_describing_errors => boolean(),
null_terminated_strings => boolean(),
no_deduplication => boolean(),
user_flags => undefined | bitstring()}.
-type t() :: #argo_header{}.
Functions
-spec format_error(dynamic(), dynamic()) -> dynamic().
-spec from_reader(Reader) -> {Reader, Header} when Reader :: binary(), Header :: t().
-spec has_user_flags(t()) -> boolean().
-spec inline_everything(t()) -> boolean().
-spec new() -> t().
-spec no_deduplication(t()) -> boolean().
-spec null_terminated_strings(t()) -> boolean().
-spec out_of_band_field_errors(t()) -> boolean().
-spec self_describing(t()) -> boolean().
-spec self_describing_errors(t()) -> boolean().
-spec set_has_user_flags(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_inline_everything(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_no_deduplication(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_null_terminated_strings(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_out_of_band_field_errors(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_self_describing(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_self_describing_errors(Header, New) -> {Header, Old} when Header :: t(), New :: boolean(), Old :: boolean().
-spec set_user_flags(Header, New) -> {Header, Old} when Header :: t(), New :: undefined | bitstring(), Old :: undefined | bitstring().
-spec to_writer(Header) -> Writer when Header :: t(), Writer :: binary().
-spec user_flags(t()) -> undefined | bitstring().