index_metadata.hpp File Reference

Provides raptor::detail::index_metadata and raptor::detail::read_index_metadata. More...

#include <cstddef>
#include <filesystem>
#include <optional>
#include <vector>
#include <raptor/argument_parsing/inspect_arguments.hpp>
#include <raptor/index.hpp>

Include dependency graph for index_metadata.hpp:

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

Go to the source code of this file.

Classes
struct	raptor::detail::ibf_metadata
	The structure of a single IBF. More...
struct	raptor::detail::index_metadata
	The metadata raptor inspect reports. More...
struct	raptor::detail::structure_metadata
	The structure of an index. Requires loading the whole index. More...

Functions
index_metadata	raptor::detail::read_index_metadata (inspect_arguments const &arguments)
	Reads the metadata of the index named by arguments.

Detailed Description

Provides raptor::detail::index_metadata and raptor::detail::read_index_metadata.

Author

Enrico Seiler <enrico.seiler AT fu-berlin.de>

Function Documentation

read_index_metadata()

index_metadata raptor::detail::read_index_metadata

(

inspect_arguments const &

arguments

)

Reads the metadata of the index named by arguments.

Reads only the parameters, unless arguments.detailed is set. Then the whole index is loaded, one part at a time.

Exceptions

sharg::validation_error	if a part of a partitioned index is missing.
sharg::parser_error	if the index cannot be read or is inconsistent.

Here is the call graph for this function:

Here is the caller graph for this function: