libzypp  17.5.0
zypp::target::hal::HalException Class Reference

Hardware abstaction layer exception. More...

#include <HalException.h>

Inheritance diagram for zypp::target::hal::HalException:

Public Member Functions

 HalException ()
 Default constructor. More...
 
 HalException (const std::string &msg_r)
 Constructor taking complete hal error message. More...
 
 HalException (const std::string &err_name, const std::string &err_msg)
 Constructor taking HAL (DBUS) error message components. More...
 
virtual ~HalException () throw ()
 Destructor. More...
 
const std::string & errorName () const
 
const std::string & errorMessage () const
 
- Public Member Functions inherited from zypp::Exception
 Exception ()
 Default ctor. More...
 
 Exception (const std::string &msg_r)
 Ctor taking a message. More...
 
 Exception (std::string &&msg_r)
 
 Exception (const std::string &msg_r, const Exception &history_r)
 Ctor taking a message and an exception to remember as history. More...
 
 Exception (std::string &&msg_r, const Exception &history_r)
 
 Exception (const std::string &msg_r, Exception &&history_r)
 
 Exception (std::string &&msg_r, Exception &&history_r)
 
virtual ~Exception () throw ()
 Dtor. More...
 
const CodeLocationwhere () const
 Return CodeLocation. More...
 
void relocate (const CodeLocation &where_r) const
 Exchange location on rethrow. More...
 
const std::string & msg () const
 Return the message string provided to the ctor. More...
 
std::string asString () const
 Error message provided by dumpOn as string. More...
 
std::string asUserString () const
 Translated error message as string suitable for the user. More...
 
void remember (const Exception &old_r)
 Store an other Exception as history. More...
 
void remember (Exception &&old_r)
 
void addHistory (const std::string &msg_r)
 Add some message text to the history. More...
 
void addHistory (std::string &&msg_r)
 
template<class TContainer >
void addToHistory (const TContainer &msgc_r)
 addHistory from string container types (oldest first) More...
 
template<class TContainer >
void moveToHistory (TContainer &&msgc_r)
 addHistory from string container types (oldest first) moving More...
 
HistoryIterator historyBegin () const
 Iterator pointing to the most recent message. More...
 
HistoryIterator historyEnd () const
 Iterator pointing behind the last message. More...
 
bool historyEmpty () const
 Whether the history list is empty. More...
 
HistorySize historySize () const
 The size of the history list. More...
 
std::string historyAsString () const
 The history as string. More...
 
std::string asUserHistory () const
 A single (multiline) string composed of asUserString and historyAsString. More...
 

Protected Member Functions

virtual std::ostream & dumpOn (std::ostream &str) const
 Overload this to print a proper error message. More...
 

Private Attributes

std::string e_name
 
std::string e_msg
 

Additional Inherited Members

- Public Types inherited from zypp::Exception
typedef exception_detail::CodeLocation CodeLocation
 
typedef std::list< std::string > History
 
typedef History::const_iterator HistoryIterator
 
typedef History::size_type HistorySize
 
- Static Public Member Functions inherited from zypp::Exception
static std::string strErrno (int errno_r)
 Make a string from errno_r. More...
 
static std::string strErrno (int errno_r, const std::string &msg_r)
 Make a string from errno_r and msg_r. More...
 
static std::string strErrno (int errno_r, std::string &&msg_r)
 
static void log (const Exception &excpt_r, const CodeLocation &where_r, const char *const prefix_r)
 Drop a logline on throw, catch or rethrow. More...
 
static void log (const char *typename_r, const CodeLocation &where_r, const char *const prefix_r)
 for not-Exception types thrown via ZYPP_THROW More...
 

Detailed Description

Hardware abstaction layer exception.

Just inherits Exception to separate hal exceptions.

Definition at line 39 of file HalException.h.

Constructor & Destructor Documentation

◆ HalException() [1/3]

zypp::target::hal::HalException::HalException ( )
inline

Default constructor.

Use ZYPP_THROW macros to throw exceptions.

Definition at line 45 of file HalException.h.

◆ HalException() [2/3]

zypp::target::hal::HalException::HalException ( const std::string &  msg_r)
inline

Constructor taking complete hal error message.

This constructor is used to generate custom error messages, in case, that no DBUS error is avaliable. Use ZYPP_THROW macros to throw exceptions.

Definition at line 54 of file HalException.h.

◆ HalException() [3/3]

zypp::target::hal::HalException::HalException ( const std::string &  err_name,
const std::string &  err_msg 
)
inline

Constructor taking HAL (DBUS) error message components.

Use ZYPP_THROW macros to throw exceptions.

Definition at line 63 of file HalException.h.

◆ ~HalException()

virtual zypp::target::hal::HalException::~HalException ( )
throw (
)
inlinevirtual

Destructor.

Definition at line 71 of file HalException.h.

Member Function Documentation

◆ errorName()

const std::string& zypp::target::hal::HalException::errorName ( ) const
inline
Returns
The HAL (DBUS) error name component.

Definition at line 76 of file HalException.h.

◆ errorMessage()

const std::string& zypp::target::hal::HalException::errorMessage ( ) const
inline
Returns
The HAL (DBUS) error message component.

Definition at line 84 of file HalException.h.

◆ dumpOn()

std::ostream & zypp::target::hal::HalException::dumpOn ( std::ostream &  str) const
protectedvirtual

Overload this to print a proper error message.

Reimplemented from zypp::Exception.

Definition at line 147 of file HalContext.cc.

Member Data Documentation

◆ e_name

std::string zypp::target::hal::HalException::e_name
private

Definition at line 93 of file HalException.h.

◆ e_msg

std::string zypp::target::hal::HalException::e_msg
private

Definition at line 94 of file HalException.h.


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