The class template that file records are based on; behaves like an std::tuple. More...
#include <seqan3/io/record.hpp>
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 () |
(Re-)Initialise all tuple elements with {} . | |
Constructors, destructor and assignment | |
record ()=default | |
Defaulted. | |
record (record const &)=default | |
Defaulted. | |
record & | operator= (record const &)=default |
Defaulted. | |
record (record &&)=default | |
Defaulted. | |
record & | operator= (record &&)=default |
Defaulted. | |
~record ()=default | |
Defaulted. | |
Related Functions | |
(Note that these are not member functions.) | |
Free function get() interface for seqan3::record based on seqan3::field. | |
This is the tuple interface via seqan3::field, e.g. | |
template<field f, typename field_types , typename field_ids > | |
auto & | get (record< field_types, field_ids > &r) |
Free function get() for seqan3::record based on seqan3::field. | |
template<field f, typename field_types , typename field_ids > | |
auto const & | get (record< field_types, field_ids > const &r) |
template<field f, typename field_types , typename field_ids > | |
auto && | get (record< field_types, field_ids > &&r) |
template<field f, typename field_types , typename field_ids > | |
auto const && | get (record< field_types, field_ids > const &&r) |
Requirements for seqan3::TupleLike | |
You can expect these (meta-)functions on all types that implement seqan3::TupleLike. | |
size_t | tuple_size_v |
A unary type trait that holds the number of elements in the tuple. More... | |
tuple_elment_t | |
A transformation trait that holds the type of elements in the tuple. More... | |
auto && | get (type &&val) |
Return the i-th element of the tuple. More... | |
Requirements for std::StrictTotallyOrdered | |
You can expect these functions on all types that implement std::StrictTotallyOrdered. | |
bool | operator< (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator<= (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator> (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
bool | operator>= (type const &lhs, type const &rhs) |
Less-than, greater-than and -or-equal comparisons. More... | |
Requirements for std::EqualityComparable | |
You can expect these functions on all types that implement std::Equality_comparable. | |
bool | operator== (type const &lhs, type const &rhs) |
(In-)Equality comparison. More... | |
bool | operator!= (type const &lhs, type const &rhs) |
(In-)Equality comparison. More... | |
The class template that file records are based on; behaves like an std::tuple.
field_types | The types of the fields in this record as a seqan3::type_list. |
field_ids | A seqan3::fields type with seqan3::field IDs corresponding to field_types. |
This class template behaves just like an 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:
|
related |
Return the i-th element of the tuple.
i | The index of the element to return (of type size_t ). |
[in,out] | val | The tuple-like object to operate on. |
|
related |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
related |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
related |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
|
related |
A transformation trait that holds the type of elements in the tuple.
i | Index of the queried element type. |
type | The tuple-like type. |
|
related |
A unary type trait that holds the number of elements in the tuple.
type | The tuple-like type. |