FEAT: Added a capture function for nested exceptions

docs/changelog.rst

@@ -6,13 +6,18 @@ Changelog
 #########
 
 ******************
-0.7.3 (unreleased)
+0.8.0 (2024-04-02)
 ******************
 
 New Features
 ============
 - Added a catch function to replace the if statement pattern (:pull:`2`). By `Nathan Miller`_.
 - Added parenthesis to the catch function to try and prevent issues (:pull:`3`). By `Nathan Miller`_.
+- Added a function to capture the error message in a standard string (:pull:`4`). By `Nathan Miller`_.
+
+Breaking Changes
+================
+- Changed the printNestedExceptions interface to only accept the exception and a header message. This will affect almost no-one but it is breaking (:pull:`4`). By `Nathan Miller`_.
 
 ******************
 0.7.2 (2023-09-27)

src/cpp/tardigrade_error_tools.cpp

@@ -78,11 +78,11 @@ namespace tardigradeErrorTools{
         return;
     }
 
-    void printNestedExceptions( const std::exception &e, std::size_t depth, std::string message){
+    void captureNestedExceptions( const std::exception &e, std::string &message, std::size_t depth ){
         /*!
-         * Print the nested exceptions starting with the one deepest (closest to the error) and ending
-         * with the outermost function call. Users should call this function by just passing in the
-         * exception. The other arguments are for recursion.
+         * Capture the nested exceptions starting with the one deepest (closest to the error) and ending
+         * with the outermost function call. Users should typically call this function by just passing in the
+         * exception and a std::string for the message. The depth is for recursion.
          * 
          * \param &e: The nested exceptions
          * \param depth: The current depth (defaults to zero)
@@ -94,14 +94,27 @@ namespace tardigradeErrorTools{
         try {
 
             std::rethrow_if_nested( e );
-            std::cerr << message;
 
         }
         catch ( const std::exception &nested ){
 
-            printNestedExceptions( nested, depth + 1, message );
+            captureNestedExceptions( nested, message, depth + 1 );
 
        }
     }
 
+    void printNestedExceptions( const std::exception &e, std::string message ){
+        /*!
+         * Print the nested exceptions starting with the one deepest (closest to the error) and ending
+         * with the outermost function call. Users should call this function by just passing in the
+         * exception.
+         * 
+         * \param &e: The nested exceptions
+         * \param message: The output message (defaults to "")
+         */
+
+        captureNestedExceptions( e, message );
+        std::cerr << message;
+    }
+
 }

src/cpp/tardigrade_error_tools.h

@@ -161,7 +161,9 @@ namespace tardigradeErrorTools{
             void print( const bool header = true );
     };
 
-    void printNestedExceptions( const std::exception &e, std::size_t depth = 0, std::string message = "");
+    void captureNestedExceptions( const std::exception &e, std::string &message, std::size_t depth = 0);
+
+    void printNestedExceptions( const std::exception &e, std::string message = "" );
 
 }