seqan3::fields< fs > Struct Template Reference

A class template that holds a choice of seqan3::field. More...

#include <seqan3/io/record.hpp>

Related Functions
(Note that these are not member functions.)
template<typename t >
SEQAN3_CONCEPT	Fields = is_value_specialisation_of_v<t, fields>
	Auxiliary concept that checks whether a type is a specialisation of seqan3::fields.

Detailed Description

template<field ... fs>
struct seqan3::fields< fs >

A class template that holds a choice of seqan3::field.

Template Parameters

fs	The fields you wish to be present in the seqan3::record returned by your file.

See also

seqan3::record

This class acts as a compile time list of seqan3::field elements. It is used in specialising file classes to determine the elements in a seqan3::record.

Example

// specify custom field combination/order to file:
sequence_file_input fin{tmp_dir/"my.fasta", fields<field::ID, field::SEQ>{}};

auto record = fin.front(); // get current record, in this case the first

// record is tuple-like type, but allows access via field identifiers:
auto & id = get<field::ID>(record);
auto & seq = get<field::SEQ>(record);

---

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

• seqan3/io/record.hpp