serialise.h File Reference

functions to convert classes to strings and back More...

#include <string>
#include <string_view>
#include "xapian/weight.h"

Include dependency graph for serialise.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Namespaces
	Xapian
	The Xapian namespace contains public interfaces for the Xapian library.

Functions
std::string	serialise_stats (const Xapian::Weight::Internal &stats)
	Serialise a stats object. More...
void	unserialise_stats (const char *p, const char *p_end, Xapian::Weight::Internal &stats)
	Unserialise a serialised stats object. More...
std::string	serialise_rset (const Xapian::RSet &omrset)
	Serialise a Xapian::RSet object. More...
Xapian::RSet	unserialise_rset (const std::string &s)
	Unserialise a serialised Xapian::RSet object. More...
std::string	serialise_document (const Xapian::Document &doc)
	Serialise a Xapian::Document object. More...
Xapian::Document	unserialise_document (std::string_view s)
	Unserialise a serialised Xapian::Document object. More...

Detailed Description

functions to convert classes to strings and back

Definition in file serialise.h.

Function Documentation

serialise_document()

std::string serialise_document

(

const Xapian::Document &

doc

)

Serialise a Xapian::Document object.

Parameters

doc	The object to serialise.

Returns

The serialisation of the Xapian::Document object.

Definition at line 183 of file serialise.cc.

References Assert, AssertEq, Xapian::Document::get_data(), Xapian::ValueIterator::get_valueno(), pack_string(), pack_uint(), pos, term, Xapian::Document::termlist_begin(), Xapian::Document::termlist_count(), Xapian::Document::termlist_end(), Xapian::Document::values_begin(), Xapian::Document::values_count(), and Xapian::Document::values_end().

Referenced by RemoteDatabase::add_document(), RemoteDatabase::replace_document(), and Xapian::Document::serialise().

serialise_rset()

std::string serialise_rset

(

const Xapian::RSet &

omrset

)

Serialise a Xapian::RSet object.

Parameters

rset	The object to serialise.

Returns

The serialisation of the Xapian::RSet object.

Definition at line 148 of file serialise.cc.

References Xapian::RSet::internal, and pack_uint().

Referenced by RemoteDatabase::set_query().

serialise_stats()

std::string serialise_stats

(

const Xapian::Weight::Internal &

stats

)

Serialise a stats object.

Parameters

stats

The stats object to serialise.

Returns

Serialisation of stats.

Definition at line 42 of file serialise.cc.

References AssertRel, Xapian::Weight::Internal::collection_size, common_prefix_length(), Xapian::Weight::Internal::db_doclength_lower_bound, Xapian::Weight::Internal::db_doclength_upper_bound, Xapian::Weight::Internal::db_unique_terms_lower_bound, Xapian::Weight::Internal::db_unique_terms_upper_bound, Xapian::Weight::Internal::have_max_part, pack_bool(), pack_uint(), Xapian::Weight::Internal::rset_size, serialise_double(), term, Xapian::Weight::Internal::termfreqs, Xapian::Weight::Internal::total_length, and usual.

Referenced by RemoteServer::msg_query(), RemoteDatabase::send_global_stats(), and Xapian::MSet::Internal::serialise().

unserialise_document()

Xapian::Document unserialise_document

(

std::string_view

s

)

Unserialise a serialised Xapian::Document object.

Parameters

s	The serialised object as a string.

Returns

The unserialised Xapian::Document object.

Definition at line 223 of file serialise.cc.

References Xapian::Document::add_posting(), Xapian::Document::add_term(), Xapian::Document::add_value(), p, pos, Xapian::Document::set_data(), term, unpack_string(), unpack_throw_serialisation_error(), and unpack_uint().

Referenced by RemoteServer::msg_adddocument(), RemoteServer::msg_replacedocument(), RemoteServer::msg_replacedocumentterm(), and Xapian::Document::unserialise().

unserialise_rset()

Xapian::RSet unserialise_rset

(

const std::string &

s

)

Unserialise a serialised Xapian::RSet object.

Parameters

s	The serialised object as a string.

Returns

The unserialised Xapian::RSet object.

Definition at line 162 of file serialise.cc.

References Xapian::RSet::add_document(), p, unpack_throw_serialisation_error(), and unpack_uint().

Referenced by RemoteServer::msg_query().

unserialise_stats()

void unserialise_stats	(	const char *	p,
		const char *	p_end,
		Xapian::Weight::Internal &	stats
	)

Unserialise a serialised stats object.

Parameters

p	Pointer to data to unserialise.
p_end	End of data to unserialise.
stats	The stats object to unserialise to.

Definition at line 92 of file serialise.cc.

References Xapian::Weight::Internal::collection_size, Xapian::Weight::Internal::db_doclength_lower_bound, Xapian::Weight::Internal::db_doclength_upper_bound, Xapian::Weight::Internal::db_unique_terms_lower_bound, Xapian::Weight::Internal::db_unique_terms_upper_bound, Xapian::Weight::Internal::have_max_part, p, Xapian::Weight::Internal::rset_size, term, Xapian::Weight::Internal::termfreqs, Xapian::Weight::Internal::total_length, unpack_bool(), unpack_throw_serialisation_error(), unpack_uint(), and unserialise_double().

Referenced by RemoteDatabase::accumulate_remote_stats(), RemoteServer::msg_query(), and Xapian::MSet::Internal::unserialise().