xapian-core/net/serialise.h

   1 /** @file serialise.h
   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_H
  22 #define XAPIAN_INCLUDED_SERIALISE_H
  23
  24 #include <string>
  25 #include "xapian/weight.h"
  26
  27 // Forward class declarations:
  28
  29 namespace Xapian {
  30     class Document;
  31     class RSet;
  32 }
  33
  34 /** Serialise a stats object.
  35  *
  36  *  @param stats        The stats object to serialise.
  37  *
  38  *  @return     Serialisation of @a stats.
  39  */
  40 std::string serialise_stats(const Xapian::Weight::Internal &stats);
  41
  42 /** Unserialise a serialised stats object.
  43  *
  44  *  @param s            The string to unserialise.
  45  *
  46  *  @param stats        The stats object to unserialise to.
  47  */
  48 void unserialise_stats(const std::string &s, Xapian::Weight::Internal &stats);
  49
  50 /** Serialise a Xapian::RSet object.
  51  *
  52  *  @param rset         The object to serialise.
  53  *
  54  *  @return             The serialisation of the Xapian::RSet object.
  55  */
  56 std::string serialise_rset(const Xapian::RSet &omrset);
  57
  58 /** Unserialise a serialised Xapian::RSet object.
  59  *
  60  *  @param s            The serialised object as a string.
  61  *
  62  *  @return             The unserialised Xapian::RSet object.
  63  */
  64 Xapian::RSet unserialise_rset(const std::string &s);
  65
  66 /** Serialise a Xapian::Document object.
  67  *
  68  *  @param doc          The object to serialise.
  69  *
  70  *  @return             The serialisation of the Xapian::Document object.
  71  */
  72 std::string serialise_document(const Xapian::Document &doc);
  73
  74 /** Unserialise a serialised Xapian::Document object.
  75  *
  76  *  @param s            The serialised object as a string.
  77  *
  78  *  @return             The unserialised Xapian::Document object.
  79  */
  80 Xapian::Document unserialise_document(const std::string &s);
  81
  82 #endif