.. index:: pair: struct; EE::UI::UIValueResult
.. _doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result:

template struct EE::UI::UIValueResult
=====================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A converted value together with its failure information. :ref:`More...<details-struct_e_e_1_1_u_i_1_1_u_i_value_result>`


.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <uivaluevalidation.hpp>
	
	template <typename T>
	struct UIValueResult {
		// fields
	
		std::optional<T> :target:`value<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1ae8b0e8dfe76016311cbfb990c698831a>`;
		:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` :target:`validation<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a8000ab5ed3247d39cbd235c849e67608>`;

		// construction
	
		:target:`UIValueResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a2405debfbb57842f59d2bb39f945f59f>`();
		:target:`UIValueResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a339b20dff3ffc12d2f6cb8a0d4f59462>`(T value);

		// methods
	
		:target:`operator bool<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1aeea6b9f32fa9676bde8d3ce8e166fd40>`() const;
		static UIValueResult :target:`success<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1aca0d2df74a7c80e5b04163adf2b3ecf6>`(T value);
		static UIValueResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a4cd0de853b759aacca8b7f043e31692c>`(:ref:`UIValueValidationResult<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result>` validation);
		static UIValueResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a88b4d5ec28c6d9d0914410f35d7998f2>`(:ref:`UIValueValidationResult::Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>` code);
		static UIValueResult :target:`error<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_result_1a2a73225d1459b8f57d3363ab70e0fb58>`(:ref:`UIValueValidationResult::Code<doxid-struct_e_e_1_1_u_i_1_1_u_i_value_validation_result_1a0339b4ed99ecbccaeee8c7647307ca59>` code, std::string debugMessage);
	};
.. _details-struct_e_e_1_1_u_i_1_1_u_i_value_result:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~

A converted value together with its failure information.

Successful results always contain a value. Failures contain no value and preserve the numeric code and optional diagnostic produced by a converter.