Loading...
Searching...
No Matches
seqan3::sequence_file_output_format< t > Interface Template Reference
IO » Sequence File

The generic concept for sequence file out formats. More...

`#include <seqan3/io/sequence_file/output_format_concept.hpp>`

Inheritance diagram for seqan3::sequence_file_output_format< t >:
[legend]

## Related Symbols

(Note that these are not member symbols.)
Requirements for seqan3::sequence_file_output_format
You can expect these members on all types that implement seqan3::sequence_file_output_format.
void | write_sequence_record (stream_type &stream, seqan3::sequence_file_output_options const &options, seq_type &&sequence, id_type &&id, qual_type &&qualities)
| Write the given fields to the specified stream.
static inline std::vector< std::string > | file_extensions
| The format type is required to provide a vector of all supported file extensions.

## Detailed Description

template<typename t>
interface seqan3::sequence_file_output_format< t >

The generic concept for sequence file out formats.

The details of this concept are only relevant to developers who wish to implement their own format. The requirements for this concept are given as related functions and type traits. Types that satisfy this concept are shown as "implementing this interface".

## Friends And Related Symbol Documentation

## write_sequence_record()

template<typename t>

void write_sequence_record | ( | stream_type & | stream,
|  | seqan3::sequence_file_output_options const & | options,
|  | seq_type && | sequence,
|  | id_type && | id,
|  | qual_type && | qualities )

related

Write the given fields to the specified stream.

Template Parameters

  stream_type | Output stream, must satisfy seqan3::output_stream_over with char.
  seq_type | Type of the seqan3::field::seq output; must satisfy std::ranges::output_range over a seqan3::alphabet.
  id_type | Type of the seqan3::field::id output; must satisfy std::ranges::output_range over a seqan3::alphabet.
  qual_type | Type of the seqan3::field::qual output; must satisfy std::ranges::output_range over a seqan3::quality_alphabet.

Parameters

  [in,out] | stream | The output stream to write into.
  [in] | options | File specific options passed to the format.
  [in] | sequence | The data for seqan3::field::seq, i.e. the "sequence".
  [in] | id | The data for seqan3::field::id, e.g. the header line in FASTA.
  [in] | qualities | The data for seqan3::field::qual.

### Additional requirements

- The format must also accept std::ignore as parameter for any of the fields, however it shall throw an exception if one of the fields required for writing the format is marked as such. [this shall be checked inside the function]

Implemented in seqan3::format_embl, seqan3::format_fasta, and seqan3::format_genbank.

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

- sequence_file/output_format_concept.hpp

Hide me