Raptor 4.0.0-rc.1
A fast and space-efficient pre-filter
Loading...
Searching...
No Matches
inspect_arguments.hpp
Go to the documentation of this file.
1// SPDX-FileCopyrightText: 2006-2026 Knut Reinert & Freie Universität Berlin
2// SPDX-FileCopyrightText: 2016-2026 Knut Reinert & MPI für molekulare Genetik
3// SPDX-License-Identifier: BSD-3-Clause
4
10#pragma once
11
12#include <cstdint>
13#include <filesystem>
14
15namespace raptor
16{
17
19enum class inspect_format : uint8_t
20{
21 text,
22 json
23};
24
26{
31 inspect_format format{inspect_format::text};
33 bool user_bins{false};
35 bool detailed{false};
36
37 // Determined by the parser, not set on the command line.
39 bool is_partitioned{false};
40};
41
42} // namespace raptor
inspect_format
The output formats of raptor inspect.
Definition inspect_arguments.hpp:20
@ text
## Key = value lines, like the header of a raptor search result.
@ json
A single JSON object.
Definition inspect_arguments.hpp:26
std::filesystem::path index_file
The index to inspect. For a partitioned index, the path without the _<part> suffix.
Definition inspect_arguments.hpp:28
bool detailed
Whether to load the whole index to also report its structure.
Definition inspect_arguments.hpp:35
bool is_partitioned
Whether index_file names a partitioned index, i.e. <index_file>_0 exists.
Definition inspect_arguments.hpp:39
std::filesystem::path out_file
The file to write the metadata to. Empty for std::cout.
Definition inspect_arguments.hpp:30
bool user_bins
Whether to list the files of every user bin.
Definition inspect_arguments.hpp:33
Hide me