26#include <seqan3/io/detail/record.hpp>
65template <detail::fields_specialisation selected_field_
ids_ = fields<field::seq, field::
id, field::qual>,
66 detail::type_list_of_sequence_file_output_formats val
id_formats_ =
67 type_list<format_embl, format_fasta, format_fastq, format_genbank, format_sam>>
86 static_assert([] ()
constexpr
88 for (
field f : selected_field_ids::as_array)
89 if (!field_ids::contains(f))
93 "You selected a field that is not valid for sequence files, please refer to the documentation "
94 "of sequence_file_output::field_ids for the accepted values.");
112 using iterator = detail::out_file_iterator<sequence_file_output>;
154 primary_stream->rdbuf()->pubsetbuf(stream_buffer.data(), stream_buffer.size());
156 std::ios_base::out | std::ios::binary);
158 if (!primary_stream->good())
159 throw file_open_error{
"Could not open file " + filename.
string() +
" for writing."};
162 secondary_stream = detail::make_secondary_ostream(*primary_stream, filename);
165 detail::set_format(format, filename);
183 template <output_stream stream_t,
186 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
stream_char_type>
189 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
191 primary_stream{&stream, stream_deleter_noop},
192 secondary_stream{&stream, stream_deleter_noop},
193 format{detail::sequence_file_output_format_exposer<file_format>{}}
195 static_assert(list_traits::contains<file_format, valid_formats>,
196 "You selected a format that is not in the valid_formats of this file.");
200 template <output_stream stream_t,
203 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
stream_char_type>
206 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
208 primary_stream{
new stream_t{std::move(stream)}, stream_deleter_default},
209 secondary_stream{&*primary_stream, stream_deleter_noop},
210 format{detail::sequence_file_output_format_exposer<file_format>{}}
212 static_assert(list_traits::contains<file_format, valid_formats>,
213 "You selected a format that is not in the valid_formats of this file.");
280 template <
typename record_t>
283 requires detail::record_like<record_t>
286 write_record(detail::get_or_ignore<field::seq>(r),
287 detail::get_or_ignore<field::id>(r),
288 detail::get_or_ignore<field::qual>(r));
312 template <
typename tuple_t>
319 write_record(detail::get_or_ignore<selected_field_ids::index_of(
field::seq)>(t),
320 detail::get_or_ignore<selected_field_ids::index_of(
field::id)>(t),
321 detail::get_or_ignore<selected_field_ids::index_of(
field::qual)>(t));
347 template <
typename arg_t,
typename ...arg_types>
374 template <std::ranges::input_range rng_t>
380 for (
auto &&
record : range)
412 template <std::ranges::input_range rng_t>
423 template <std::ranges::input_range rng_t>
429 #if defined(__GNUC__) && (__GNUC__ == 9)
430 for (
auto &&
record : range)
447 return *secondary_stream;
467 stream_ptr_t primary_stream{
nullptr, stream_deleter_noop};
469 stream_ptr_t secondary_stream{
nullptr, stream_deleter_noop};
472 using format_type =
typename detail::variant_from_tags<
valid_formats,
473 detail::sequence_file_output_format_exposer>::type;
479 template <
typename seq_t,
typename id_t,
typename qual_t>
480 void write_record(seq_t && seq, id_t &&
id, qual_t && qual)
482 assert(!
format.valueless_by_exception());
486 f.write_sequence_record(*secondary_stream,
505template <output_stream stream_t,
513template <output_stream stream_t,
521template <output_stream stream_t,
531template <output_stream stream_t,
A class for writing sequence files, e.g. FASTA, FASTQ ...
Definition: output.hpp:69
sequence_file_output & operator=(sequence_file_output const &)=delete
Copy assignment is explicitly deleted, because you can't have multiple access to the same file.
void push_back(record_t &&r)
Write a seqan3::record to the file.
Definition: output.hpp:281
sequence_file_output(stream_t &, file_format const &, selected_field_ids const &) -> sequence_file_output< selected_field_ids, type_list< file_format > >
This is an overloaded member function, provided for convenience. It differs from the above function o...
sequence_file_output(std::filesystem::path filename, selected_field_ids const &fields_tag=selected_field_ids{})
Construct from filename.
Definition: output.hpp:150
sequence_file_output(stream_t &&, file_format const &) -> sequence_file_output< typename sequence_file_output<>::selected_field_ids, type_list< file_format > >
This is an overloaded member function, provided for convenience. It differs from the above function o...
void const_iterator
The const iterator type is void, because files are not const-iterable.
Definition: output.hpp:114
char stream_char_type
Character type of the stream(s).
Definition: output.hpp:80
std::default_sentinel_t sentinel
The type returned by end().
Definition: output.hpp:116
sequence_file_output(stream_t &&, file_format const &, selected_field_ids const &) -> sequence_file_output< selected_field_ids, type_list< file_format > >
Deduction guide for given stream, file format and field ids.
friend sequence_file_output operator|(rng_t &&range, sequence_file_output &&f)
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: output.hpp:424
sequence_file_output(sequence_file_output &&)=default
Move construction is defaulted.
void push_back(tuple_t &&t)
Write a record in form of a std::tuple to the file.
Definition: output.hpp:313
sequence_file_output & operator=(sequence_file_output &&)=default
Move assignment is defaulted.
sequence_file_output(sequence_file_output const &)=delete
Copy construction is explicitly deleted, because you can't have multiple access to the same file.
sequence_file_output(stream_t &, file_format const &) -> sequence_file_output< typename sequence_file_output<>::selected_field_ids, type_list< file_format > >
Deduction guide for given stream and file format.
friend sequence_file_output & operator|(rng_t &&range, sequence_file_output &f)
Write a range of records (or tuples) to the file.
Definition: output.hpp:413
valid_formats_ valid_formats
A seqan3::type_list with the possible formats.
Definition: output.hpp:78
selected_field_ids_ selected_field_ids
A seqan3::fields list with the fields selected for the record.
Definition: output.hpp:76
~sequence_file_output()=default
Destructor is defaulted.
sequence_file_output_options options
The options are public and its members can be set directly.
Definition: output.hpp:440
sequence_file_output & operator=(rng_t &&range)
Write a range of records (or tuples) to the file.
Definition: output.hpp:375
void emplace_back(arg_t &&arg, arg_types &&... args)
Write a record to the file by passing individual fields.
Definition: output.hpp:348
void value_type
The value type (void).
Definition: output.hpp:102
sentinel end() noexcept
Returns a sentinel for comparison with iterator.
Definition: output.hpp:257
void reference
The reference type (void).
Definition: output.hpp:104
void const_reference
The const reference type (void).
Definition: output.hpp:106
sequence_file_output()=delete
Default constructor is explicitly deleted, you need to give a stream or file name.
detail::out_file_iterator< sequence_file_output > iterator
The iterator type of this view (an output iterator).
Definition: output.hpp:112
sequence_file_output(stream_t &stream, file_format const &format_tag, selected_field_ids const &fields_tag=selected_field_ids{})
Construct from an existing stream and with specified format.
Definition: output.hpp:188
sequence_file_output(stream_t &&stream, file_format const &format_tag, selected_field_ids const &fields_tag=selected_field_ids{})
This is an overloaded member function, provided for convenience. It differs from the above function o...
Definition: output.hpp:205
iterator begin() noexcept
Returns an iterator to current position in the file.
Definition: output.hpp:238
void size_type
The size type (void).
Definition: output.hpp:108
Provides seqan3::views::elements.
The <filesystem> header from C++17's standard library.
field
An enumerator for the fields used in file formats.
Definition: record.hpp:63
@ id
The identifier, usually a string.
@ seq
The "sequence", usually a range of nucleotides or amino acids.
@ qual
The qualities, usually in Phred score notation.
Whether a type behaves like a tuple.
Provides various utility functions.
Provides exceptions used in the I/O module.
Provides various utility functions required only for output.
The main SeqAn3 namespace.
Definition: cigar_operation_table.hpp:2
Provides the seqan3::detail::out_file_iterator class template.
The <ranges> header from C++20's standard library.
Provides the seqan3::record template and the seqan3::field enum.
Provides seqan3::detail::record_like.
Provides seqan3::sequence_file_output_options.
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:191
The options type defines various option members that influence the behaviour of all or some formats.
Definition: output_options.hpp:26
Type that contains multiple types.
Definition: type_list.hpp:29
Provides traits for seqan3::type_list.
Provides seqan3::tuple_like.
Provides seqan3::views::convert.
Provides seqan3::views::zip.