Boost Exception

exception

#include <boost/exception/exception.hpp>

namespace
boost
    {
    class
    exception
        {
        public:

        virtual char const * what() const throw();

        protected:

        exception();
        exception( exception const & x );
        ~exception();

        private:

        ---unspecified---
        };
    }

Class boost::exception is designed to be used as a universal base for user-defined exception types.

An object of any type deriving from boost::exception can store data of arbitrary types, using the error_info wrapper and operator<<().

To retrieve data from a boost::exception object, use the get_error_info() function template.

exception constructors

        exception();
        exception( exception const & x );

Effects:

  • Default constructor: initializes an empty boost::exception object.
  • Copy constructor: initializes a boost::exception object which shares with x all data added through operator<<(), including data that is added at a future time.

Throws:

Nothing.

exception destructor

        ~exception();

Effects:

Frees all resources associated with a boost::exception object.

Throws:

Nothing.

exception::what()

        virtual char const * what() const throw();

Returns:

An string representation of all data stored in the boost::exception object by the operator<<() function. See "Tutorial: Logging of boost::exception Objects" for details.

Throws:

Nothing.

Note:

The return value remains valid until the exception object from which it is obtained is destroyed or modified.

See also:

BOOST_ERROR_INFO
Boost Exception
current_exception
enable_current_exception
enable_error_info
error_info
get_error_info
operator<</exception
Tutorial: Integrating Boost Exception in Existing Exception Class Hierarchies
Tutorial: Logging of boost::exception Objects
Tutorial: Transporting of Arbitrary Data to the Catch Site
Tutorial: Transporting of Exceptions between Threads