xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
Public Member Functions | List of all members
xtd::format_exception Class Reference

#include <format_exception.h>

Definition

The exception that is thrown when the format of an argument does not meet the parameter specifications of the invoked method.

Namespace
xtd
Library
xtd.core
Examples
The following example demonstrates how to throw and catch an format_exception.
#include <xtd/xtd>
using namespace std;
using namespace xtd;
int main() {
cout << ustring::format("{}", exception()) << endl;
cout << ustring::format("{}", invalid_argument("Invvalid argument")) << endl;
cout << ustring::format("{}", system_exception("System exception")) << endl;
cout << ustring::format("{}", argument_out_of_range_exception("Argument out of range exception")) << endl;
}
// This code produces the following output :
//
// exception: std::exception
// exception: Invvalid argument
// xtd::system_exception : System exception
// at main [0x00005620] in /Users/gammasoft71/Projects/xtd/build/xtd.examples/xtd.core.examples/format/format_exception/Debug/format_exception:line 0
// xtd::argument_out_of_range_exception : Argument out of range exception
// at main [0x00005620] in /Users/gammasoft71/Projects/xtd/build/xtd.examples/xtd.core.examples/format/format_exception/Debug/format_exception:line 0

Public Member Functions

 format_exception (const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::error_code &error, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const std::exception &inner_exception, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
 format_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &info=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class format_exception. More...
 
- Public Member Functions inherited from xtd::system_exception
 system_exception (const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::error_code &error, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const std::exception &inner_exception, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
 system_exception (const xtd::ustring &message, const std::exception &inner_exception, const std::error_code &error, const xtd::ustring &help_link, const xtd::diagnostics::stack_frame &information=xtd::diagnostics::stack_frame::empty())
 Create a new instance of class system_exception. More...
 
virtual std::error_code error_code () const noexcept
 Get error associate to the exception. More...
 
virtual const xtd::ustringfile_path () const noexcept
 Get file path where exception occurred. More...
 
virtual const xtd::ustringhelp_link () const noexcept
 Gets a link to the help file associated with this exception. More...
 
virtual exception_ref inner_exception () const noexcept
 Gets the exception instance that caused the current exception. More...
 
virtual uint32_t line_numer () const noexcept
 Get Line number where the exception occurred. More...
 
virtual const xtd::ustringmember_name () const noexcept
 Get file member where exception occurred. More...
 
virtual const xtd::ustringmessage () const noexcept
 Get message associate to the exception. More...
 
virtual const xtd::ustringname () const noexcept
 Get full class name the exception. More...
 
virtual xtd::ustring stack_trace () const noexcept
 Gets a string representation of the immediate frames on the call stack. More...
 
xtd::ustring to_string () const noexcept override
 Returns a string that represents the current exception. More...
 
const char * what () const noexcept override
 Get message associate to the exception. More...
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object. More...
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object. More...
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type. More...
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance. More...
 

Additional Inherited Members

- Public Types inherited from xtd::system_exception
using exception_ref = std::optional< std::reference_wrapper< const std::exception > >
 Optional reference wrapper on std::eception. More...
 
- Static Public Member Functions inherited from xtd::system_exception
static bool enable_stack_trace ()
 Gets or sets if the generation of the stack trace is enabled. More...
 
static void enable_stack_trace (bool enable)
 
- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal. More...
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance. More...
 

Constructor & Destructor Documentation

◆ format_exception() [1/10]

xtd::format_exception::format_exception ( const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty())
inline

Create a new instance of class format_exception.

Parameters
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.
Remarks
Message is set with the default message associate to the exception.

◆ format_exception() [2/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [3/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::error_code &  error,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
errorError code associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [4/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
help_linkHelp link string associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [5/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::error_code &  error,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
errorError code associate to the exception.
help_linkHelp link string associate to the exception.

◆ format_exception() [6/10]

xtd::format_exception::format_exception ( const std::exception &  inner_exception,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inline

Create a new instance of class format_exception.

Parameters
inner_exceptionThe exception that is the cause of the current exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.
Remarks
Message is set with the default message associate to the exception.

◆ format_exception() [7/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [8/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const std::error_code &  error,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
errorError code associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [9/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
help_linkHelp link string associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

◆ format_exception() [10/10]

xtd::format_exception::format_exception ( const xtd::ustring message,
const std::exception &  inner_exception,
const std::error_code &  error,
const xtd::ustring help_link,
const xtd::diagnostics::stack_frame info = xtd::diagnostics::stack_frame::empty() 
)
inlineexplicit

Create a new instance of class format_exception.

Parameters
messageMessage string associate to the exception.
inner_exceptionThe exception that is the cause of the current exception.
errorError code associate to the exception.
help_linkHelp link string associate to the exception.
information(optional) Conatains current information about memeber name, file path and line number in the file where the exception is occurred. Typically current_stack_frame_.

The documentation for this class was generated from the following file: