common/serialise.h

Go to the documentation of this file.

/* @file serialise.h
 * @brief functions to convert classes to strings and back
 *
 * Copyright (C) 2006,2007 Olly Betts
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
 */

#ifndef XAPIAN_INCLUDED_SERIALISE_H
#define XAPIAN_INCLUDED_SERIALISE_H

#include <xapian/visibility.h>
#include <string>
#include "noreturn.h"

// Forward class declarations:

namespace Xapian {
    class Document;
    class Error;
    class MSet;
    class RSet;
    class Weight;
}

class Stats;

XAPIAN_VISIBILITY_DEFAULT
std::string encode_length(size_t len);

XAPIAN_VISIBILITY_DEFAULT
size_t decode_length(const char ** p, const char *end, bool check_remaining);

XAPIAN_VISIBILITY_DEFAULT
std::string serialise_error(const Xapian::Error &e);

XAPIAN_VISIBILITY_DEFAULT
XAPIAN_NORETURN(
void unserialise_error(const std::string &error_string,
                       const std::string &prefix,
                       const std::string &new_context));

std::string serialise_stats(const Stats &stats);

Stats unserialise_stats(const std::string &s);

std::string serialise_mset_pre_30_5(const Xapian::MSet &mset);

std::string serialise_mset(const Xapian::MSet &mset);

Xapian::MSet unserialise_mset(const std::string &s);

std::string serialise_rset(const Xapian::RSet &omrset);

Xapian::RSet unserialise_rset(const std::string &s);

XAPIAN_VISIBILITY_DEFAULT
std::string serialise_document(const Xapian::Document &doc);

XAPIAN_VISIBILITY_DEFAULT
Xapian::Document unserialise_document(const std::string &s);

#endif

---