Xapian::AssertionError Class Reference

AssertionError is thrown if a logical assertion inside Xapian fails. More...

#include <error.h>

Inheritance diagram for Xapian::AssertionError:

[legend]

Collaboration diagram for Xapian::AssertionError:

[legend]

List of all members.

Public Member Functions
	AssertionError (const std::string &msg_, const std::string &context_=std::string(), int errno_=0)
	General purpose constructor.
	AssertionError (const std::string &msg_, int errno_)
	Construct from message and errno value.
Private Member Functions
	AssertionError (const std::string &msg_, const std::string &context_, const char *error_string_)
	Private constructor for use by remote backend.
	AssertionError (const std::string &msg_, const std::string &context_, const char *type_, const char *error_string_)
	Constructor for use by constructors of derived classes.
	AssertionError (const std::string &msg_, const std::string &context_, const char *type_, int errno_)
	Constructor for use by constructors of derived classes.

---

Detailed Description

AssertionError is thrown if a logical assertion inside Xapian fails.

In a debug build of Xapian, a failed assertion in the core library code will cause AssertionError to be thrown.

This represents a bug in Xapian (either an invariant, precondition, etc has been violated, or the assertion is incorrect!)

Definition at line 176 of file error.h.

---

Constructor & Destructor Documentation

Xapian::AssertionError::AssertionError	(	const std::string &	msg_,
		const std::string &	context_,
		const char *	error_string_
	)			[inline, private]

Private constructor for use by remote backend.

For internal use only.

Parameters:

error_string_

Optional string describing error. May be NULL.

Definition at line 183 of file error.h.

Xapian::AssertionError::AssertionError	(	const std::string &	msg_,
		const std::string &	context_ = std::string(),
		int	errno_ = 0
	)			[inline, explicit]

General purpose constructor.

Parameters:

	msg_	Message giving details of the error, intended for human consumption.
	context_	Optional context information for this error.
	errno_	Optional errno value associated with this error.

Definition at line 192 of file error.h.

Xapian::AssertionError::AssertionError	(	const std::string &	msg_,
		int	errno_
	)			[inline]

Construct from message and errno value.

Parameters:

	msg_	Message giving details of the error, intended for human consumption.
	errno_	Optional errno value associated with this error.

Definition at line 200 of file error.h.

Xapian::AssertionError::AssertionError	(	const std::string &	msg_,
		const std::string &	context_,
		const char *	type_,
		const char *	error_string_
	)			[inline, private]

Constructor for use by constructors of derived classes.

For internal use only.

Definition at line 206 of file error.h.

Xapian::AssertionError::AssertionError	(	const std::string &	msg_,
		const std::string &	context_,
		const char *	type_,
		int	errno_
	)			[inline, private]

Constructor for use by constructors of derived classes.

For internal use only.

Definition at line 212 of file error.h.

---

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

• include/xapian/error.h