SeqAn3 3.3.0-rc.1
The Modern C++ library for sequence analysis.
seqan3::record< field_types, field_ids > Struct Template Reference

The class template that file records are based on; behaves like a std::tuple. More...

#include <seqan3/io/record.hpp>

+ Inheritance diagram for seqan3::record< field_types, field_ids >:

Public Types

using base_type = detail::transfer_template_args_onto_t< field_types, std::tuple >
 A specialisation of std::tuple.

Public Member Functions

void clear () noexcept(noexcept(std::apply(expander, std::declval< record & >())))
 Clears containers that provide .clear() and (re-)initialises all other elements with = {}.
Constructors, destructor and assignment
 record ()=default
 record (record const &)=default
recordoperator= (record const &)=default
 record (record &&)=default
recordoperator= (record &&)=default
 ~record ()=default

Additional Inherited Members

Detailed Description

template<typename field_types, typename field_ids>
struct seqan3::record< field_types, field_ids >

The class template that file records are based on; behaves like a std::tuple.

Template Parameters
field_typesThe types of the fields in this record as a seqan3::type_list.
field_idsA seqan3::fields type with seqan3::field IDs corresponding to field_types.

This class template behaves just like a std::tuple, with the exception that it provides an additional get-interface that takes a seqan3::field identifier. The traditional get interfaces (via index and via type) are also supported, but discouraged, because accessing via seqan3::field is unambiguous and better readable.


For input files this template is specialised automatically and provided by the file via its record_type member. For output files you my define it locally and pass instances of this to the output file's push_back().

This is how it works:

#include <string>
#include <vector>
int main()
using namespace seqan3::literals;
// The order of the types below represent a mapping between the type and the key.
// record_type now mimics std::tuple<std::string, dna4_vector, std::vector<phred42>>,
// the order also depends on selected_ids
record_type my_record{};
std::get<1>(my_record) = "the most important sequence in the database"; // access via index
std::get<std::string>(my_record) = "the least important sequence in the database"; // access via type
Provides seqan3::dna4, container aliases and string literals.
The SeqAn namespace for literals.
Provides seqan3::phred42 quality scores.
Provides the seqan3::record template and the seqan3::field enum.
A class template that holds a choice of seqan3::field.
Definition: record.hpp:128
The class template that file records are based on; behaves like a std::tuple.
Definition: record.hpp:192
Type that contains multiple types.
Definition: type_list.hpp:29
Provides seqan3::type_list.

The documentation for this struct was generated from the following file: