xtd::runtime::exception_services::exception_dispatch_info Class Reference

Inheritance diagram for xtd::runtime::exception_services::exception_dispatch_info:

Definition

Represents an exception whose state is captured at a certain point in code.

Definition

class exception_dispatch_info final : public xtd::object;

Header

#include <xtd/runtime/exception_services/exception_dispatch_info>

Namespace

xtd::runtime

Library

xtd.core

Remarks

An xtd::runtime::exception_services::exception_dispatch_info object stores the stack trace information that an exception contains at the point where it's captured. The exception can then be thrown at another time and possibly on another thread by calling the xtd::runtime::exception_services::exception_dispatch_info.rethrow method. The exception is thrown as if it had flowed from the point where it was captured to the point where the xtd::runtime::exception_services::exception_dispatch_info::rethrow method is called.

For an example, see Capture exceptions to rethrow later.

Public Properties
auto	exception_captured () const noexcept -> bool
	Gets a value indicating whether the exception is caught or not.
auto	source_exception () const noexcept -> xtd::ptr< xtd::exception >
	Gets the exception that's represented by the current instance.
auto	rethrow () -> void
	Rethrows the exception that's represented by the current xtd::runtime::exception_services::exception_dispatch_info object, after restoring the state that was saved when the exception was captured.
template<class exception_t> requires std::derived_from<exception_t, xtd::exception>
static auto	capture (const exception_t &source) -> exception_dispatch_info
	Creates an xtd::runtime::exception_services::exception_dispatch_info object that represents the specified exception at the current point in code.
static auto	capture () -> exception_dispatch_info
	Creates an xtd::runtime::exception_services::exception_dispatch_info object that represents the specified exception at the current point in code.
template<class exception_t>
static auto	rethrow (const exception_t &source) -> void
	Rehrows the source exception, maintaining the original stack trace information.

Public Operators
	operator bool () const noexcept
	Convert to boolean operator.
	operator const std::exception_ptr & () const noexcept
	operator std::exception_ptr () noexcept

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual bool	equals (const object &obj) const noexcept
	Determines whether the specified object is equal to the current object.
virtual xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.
virtual type_object	get_type () const noexcept
	Gets the type of the current instance.
template<class object_t>
xtd::unique_ptr_object< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.
virtual xtd::string	to_string () const
	Returns a xtd::string that represents the current object.
template<class object_a_t, class object_b_t>
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.
template<class object_a_t, class object_b_t>
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Member Function Documentation

exception_captured()

auto xtd::runtime::exception_services::exception_dispatch_info::exception_captured ( ) const -> bool

inlinenodiscardnoexcept

Gets a value indicating whether the exception is caught or not.

Returns

true if the exception is captured; otherwise false.

source_exception()

auto xtd::runtime::exception_services::exception_dispatch_info::source_exception ( ) const -> xtd::ptr<xtd::exception>

inlinenodiscardnoexcept

Gets the exception that's represented by the current instance.

Returns

The exception that's represented by the current instance.

Remarks

This property is used by the Task Parallel Library, for example, to combine multiple exceptions in an xtd::aggregate_exception object. It's not intended to be used by application code. Use the xtd::runtime::exception_services::exception_dispatch_info::rethrow method to restore the state of the captured exception and throw it.

capture() [1/2]

template<class exception_t>
requires std::derived_from<exception_t, xtd::exception>

static auto xtd::runtime::exception_services::exception_dispatch_info::capture ( const exception_t & source ) -> exception_dispatch_info

inlinestaticnodiscard

Creates an xtd::runtime::exception_services::exception_dispatch_info object that represents the specified exception at the current point in code.

Parameters

source

The exception whose state is captured, and which is represented by the returned object.

Returns

An object that represents the specified exception at the current point in code.

Remarks

You can use the xtd::runtime::exception_services::exception_dispatch_info object that's returned by this method at another time and possibly on another thread to rethrow the specified exception, as if the exception had flowed from the point where it was captured to the point where it's rethrown.

If the exception is active when it's captured, the current stack trace information that's contained in the exception is stored. If it's inactive, that is, if it has not been thrown, it doesn't have any stack trace information.

capture() [2/2]

static auto xtd::runtime::exception_services::exception_dispatch_info::capture ( ) -> exception_dispatch_info

inlinestaticnodiscard

Creates an xtd::runtime::exception_services::exception_dispatch_info object that represents the specified exception at the current point in code.

Returns

An object that represents the specified exception at the current point in code.

Remarks

You can use the xtd::runtime::exception_services::exception_dispatch_info object that's returned by this method at another time and possibly on another thread to rethrow the specified exception, as if the exception had flowed from the point where it was captured to the point where it's rethrown.

If the exception is active when it's captured, the current stack trace information that's contained in the exception is stored. If it's inactive, that is, if it has not been thrown, it doesn't have any stack trace information.

rethrow() [1/2]

auto xtd::runtime::exception_services::exception_dispatch_info::rethrow ( ) -> void

inline

Rethrows the exception that's represented by the current xtd::runtime::exception_services::exception_dispatch_info object, after restoring the state that was saved when the exception was captured.

rethrow() [2/2]

template<class exception_t>

static auto xtd::runtime::exception_services::exception_dispatch_info::rethrow ( const exception_t & source ) -> void

inlinestatic

Rehrows the source exception, maintaining the original stack trace information.

operator bool()

xtd::runtime::exception_services::exception_dispatch_info::operator bool ( ) const

inlineexplicitnoexcept

Convert to boolean operator.

Returns

true if exception is captured; otherwise false.

---

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

• xtd.core/include/xtd/runtime/exception_services/exception_dispatch_info.hpp