xapian-core/net/serialise-error.h

   1 /** @file
   2  * @brief functions to convert classes to strings and back
   3  */
   4 /* Copyright (C) 2006,2007,2008,2009,2012,2014 Olly Betts
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #ifndef XAPIAN_INCLUDED_SERIALISE_ERROR_H
  22 #define XAPIAN_INCLUDED_SERIALISE_ERROR_H
  23
  24 #include <string>
  25 #include "noreturn.h"
  26
  27 // Forward class declarations:
  28
  29 namespace Xapian {
  30     class Error;
  31 }
  32
  33 /** Serialise a Xapian::Error object to a string.
  34  *
  35  *  @param e    The Xapian::Error object to serialise.
  36  *
  37  *  @return     Serialisation of @a e.
  38  */
  39 std::string serialise_error(const Xapian::Error &e);
  40
  41 /** Unserialise a Xapian::Error object and throw it.
  42  *
  43  *  Note: does not return!
  44  *
  45  *  @param error_string         The string to unserialise.
  46  *  @param prefix               Optional prefix to prepend to the unserialised
  47  *                              Error's @a msg field.
  48  *  @param new_context          Optional context to replace the context in
  49  *                              the error.  If this is specified, any existing
  50  *                              context will be noted in the Error's @a msg
  51  *                              field.
  52  */
  53 XAPIAN_NORETURN(
  54 void unserialise_error(const std::string &error_string,
  55                        const std::string &prefix,
  56                        const std::string &new_context));
  57
  58 #endif