1package Xapian::Error;
2
3=head1 NAME
4
5Xapian::Error - Base class for all exceptions in Xapian
6
7=head1 DESCRIPTION
8
9This is an abstract class in C++, i.e. it cannot be instantiated directly,
10hence in Perl it has no C<new> method.
11
12=head2 Compatibility with Search::Xapian
13
14Search::Xapian overloads <""> (stringification) on this class for compatibility
15with Search::Xapian < 1.2.3 which threw string exceptions in certain cases.
161.2.3 was released in 2010, so you can safely assume that all exceptions from
17Search::Xapian are objects now.
18
19=head1 METHODS
20
21All exception objects have the following methods
22
23=head2 get_msg
24
25Returns a string with a descriptive error message, useful for outputting
26
27=head2 get_type
28
29The type of this error (e.g. "DocNotFoundError").
30
31=head2 get_context
32
33Optional context information, returned as a string
34
35=head2 get_error_string
36
37Returns any error string from errno or similar associated with this error
38
39=cut
401;
41