std::string diagnostic_information(
    const pika::exception_info& xi)

Description

Extract the diagnostic information embedded in the given exception and return a string holding a formatted message.

//////////////////////////////////////////////////////////////////////// The function \acan be used to extract all diagnostic information stored in the given exception instance as a formatted string. This simplifies debug output as it composes the diagnostics into one, easy to use function call. This includes the name of the source file and line number, the sequence number of the OS-thread and the pika-thread id, the locality id and the stack backtrace of the point where the original exception was thrown.

Declared at: libs/pika/runtime/include/pika/runtime/custom_exception_info.hpp:165

Parameters

const pika::exception_info& xi

The parameter \pwill be inspected for all diagnostic information elements which have been stored at the point where the exception was thrown. This parameter can be one of the following types: \a\a\aor\a

Returns

The formatted string holding all of the available diagnostic information stored in the given exception instance.