decode_result¶
-
template<typename _Input, typename _Output, typename _State>
class ztd::text::decode_result : public ztd::text::stateless_decode_result<_Input, _Output>¶ The result of all decode operations from encoding objects and higher-level calls (such as ztd_text_decode).
Public Functions
-
template<typename _ArgInput, typename _ArgOutput, typename _ArgState>
inline constexpr decode_result(_ArgInput &&__input, _ArgOutput &&__output, _ArgState &&__state, encoding_error __error_code = encoding_error::ok)¶ Constructs a ztd::text::decode_result, defaulting the error code to ztd::text::encoding_error::ok if not provided.
- Parameters
__input – [in] The input range to store.
__output – [in] The output range to store.
__state – [in] The state related to the Encoding that performed the decode operation.
__error_code – [in] The error code for the decoding opertion, if any.
-
template<typename _ArgInput, typename _ArgOutput, typename _ArgState>
inline constexpr decode_result(_ArgInput &&__input, _ArgOutput &&__output, _ArgState &&__state, encoding_error __error_code, ::std::size_t __handled_errors)¶ Constructs a ztd::text::decode_result with the provided parameters and information, including whether or not an error was handled.
- Parameters
__input – [in] The input range to store.
__output – [in] The output range to store.
__state – [in] The state related to the Encoding that performed the decode operation.
__error_code – [in] The error code for the decode operation, taken as the first of either the decode operation that failed.
__handled_errors – [in] Whether or not an error was handled. Some error handlers are corrective (see ztd::text::replacement_handler_t), and so the error code is not enough to determine if the handler was invoked. This allows the value to be provided directly when constructing this result type.
-
inline constexpr bool errors_were_handled() const noexcept¶
Whether or not any errors were handled.
- Returns
Simply checks whether
handled_errorsis greater than 0.
Public Members
-
::ztd::reference_wrapper<_State> state¶
The state of the associated Encoding used for decoding input code units to code points.
-
_Input input¶
The reconstructed input_view object, with its .begin() incremented by the number of code units successfully read (can be identical to .begin() on original range on failure).
-
_Output output¶
The reconstructed output_view object, with its .begin() incremented by the number of code units successfully written (can be identical to .begin() on original range on failure).
-
encoding_error error_code¶
The kind of error that occured, if any.
-
::std::size_t handled_errors¶
Whether or not the error handler was invoked, regardless of if the error_code is set or not set to ztd::text::encoding_error::ok.
-
template<typename _ArgInput, typename _ArgOutput, typename _ArgState>