Parameters for ARI text encoding. More...
#include <text.h>
Collaboration diagram for cace_ari_text_enc_opts_t:Data Fields | |
| enum cace_ari_text_scheme_prefix_e | scheme_prefix |
| True if the scheme is present at the start of the text. | |
| enum cace_ari_text_aritype_e | show_ari_type |
| Determine how to show cace_ari_type_t values. | |
| enum cace_ari_int_base_e | int_base |
| Desired base of integer values. | |
| char | float_form |
| One of 'f', 'g', or 'e' for decimal format, or 'a' for hexadecimal. | |
| bool | text_identity |
| True if specific text can be left unquoted. | |
| enum cace_ari_bstr_form_e | bstr_form |
| Desired encoding form for byte string values. | |
| bool | time_text |
| True if time values should be in text form. | |
Detailed Description
Parameters for ARI text encoding.
Use CACE_ARI_TEXT_ENC_OPTS_DEFAULT to initialize these contents.
Field Documentation
◆ bstr_form
| enum cace_ari_bstr_form_e cace_ari_text_enc_opts_t::bstr_form |
Desired encoding form for byte string values.
This defaults to base-16 (hexadecimal strings).
Referenced by cace_ari_text_encode_lit().
◆ float_form
| char cace_ari_text_enc_opts_t::float_form |
One of 'f', 'g', or 'e' for decimal format, or 'a' for hexadecimal.
Referenced by cace_ari_text_encode_lit(), and test_ari_text_encode_lit_prim_float64().
◆ int_base
| enum cace_ari_int_base_e cace_ari_text_enc_opts_t::int_base |
Desired base of integer values.
This defaults to 10 (decimal).
Referenced by cace_ari_text_encode_lit(), test_ari_text_encode_lit_prim_int(), and test_ari_text_encode_lit_prim_uint().
◆ scheme_prefix
| enum cace_ari_text_scheme_prefix_e cace_ari_text_enc_opts_t::scheme_prefix |
True if the scheme is present at the start of the text.
This defaults to CACE_ARI_TEXT_SCHEME_FIRST.
Referenced by cace_ari_text_encode_execset(), cace_ari_text_encode_prefix(), cace_ari_text_encode_report(), cace_ari_text_encode_rptset(), and test_ari_text_encode_ariref().
◆ show_ari_type
| enum cace_ari_text_aritype_e cace_ari_text_enc_opts_t::show_ari_type |
Determine how to show cace_ari_type_t values.
This defaults to CACE_ARI_TEXT_ARITYPE_TEXT.
Referenced by cace_ari_text_encode_lit(), and cace_ari_text_encode_objref().
◆ text_identity
| bool cace_ari_text_enc_opts_t::text_identity |
True if specific text can be left unquoted.
Referenced by cace_ari_text_encode_lit().
◆ time_text
| bool cace_ari_text_enc_opts_t::time_text |
True if time values should be in text form.
False to use decimal fraction form.
Referenced by cace_ari_text_encode_lit().
The documentation for this struct was generated from the following file:
- src/cace/ari/text.h
