View Source argo_header (argo v1.0.4)

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{inline_everything :: boolean(),
                 self_describing :: boolean(),
                 out_of_band_field_errors :: boolean(),
                 self_describing_errors :: boolean(),
                 null_terminated_strings :: boolean(),
                 no_deduplication :: boolean(),
                 has_user_flags :: boolean(),
                 user_flags :: undefined | bitstring()}.

Functions

-spec format_error(dynamic(), dynamic()) -> dynamic().
-spec from_reader(Reader) -> {Reader, Header} when Reader :: binary(), Header :: t().
Link to this function

has_user_flags(Argo_header)

View Source
-spec has_user_flags(t()) -> boolean().
Link to this function

inline_everything(Argo_header)

View Source
-spec inline_everything(t()) -> boolean().
-spec new() -> t().
-spec new(options()) -> t().
Link to this function

no_deduplication(Argo_header)

View Source
-spec no_deduplication(t()) -> boolean().
Link to this function

null_terminated_strings(Argo_header)

View Source
-spec null_terminated_strings(t()) -> boolean().
Link to this function

out_of_band_field_errors(Argo_header)

View Source
-spec out_of_band_field_errors(t()) -> boolean().
Link to this function

self_describing(Argo_header)

View Source
-spec self_describing(t()) -> boolean().
Link to this function

self_describing_errors(Argo_header)

View Source
-spec self_describing_errors(t()) -> boolean().
Link to this function

set_has_user_flags(Header, New)

View Source
-spec set_has_user_flags(Header, New) -> {Header, Old}
                      when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_inline_everything(Header, New)

View Source
-spec set_inline_everything(Header, New) -> {Header, Old}
                         when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_no_deduplication(Header, New)

View Source
-spec set_no_deduplication(Header, New) -> {Header, Old}
                        when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_null_terminated_strings(Header, New)

View Source
-spec set_null_terminated_strings(Header, New) -> {Header, Old}
                               when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_out_of_band_field_errors(Header, New)

View Source
-spec set_out_of_band_field_errors(Header, New) -> {Header, Old}
                                when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_self_describing(Header, New)

View Source
-spec set_self_describing(Header, New) -> {Header, Old}
                       when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_self_describing_errors(Header, New)

View Source
-spec set_self_describing_errors(Header, New) -> {Header, Old}
                              when Header :: t(), New :: boolean(), Old :: boolean().
Link to this function

set_user_flags(Header, New)

View Source
-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().