 |
SeqAn3
3.0.2
The Modern C++ library for sequence analysis.
|
|
Go to the documentation of this file.
30 #include <seqan3/io/detail/record.hpp>
164 template <detail::fields_specialisation selected_field_
ids_ = fields<field::seq, field::
id, field::qual>,
165 detail::type_list_of_sequence_file_output_formats val
id_formats_ =
166 type_list<format_embl, format_fasta, format_fastq, format_genbank, format_sam>>
185 static_assert([] () constexpr
187 for (
field f : selected_field_ids::as_array)
188 if (!field_ids::contains(f))
192 "You selected a field that is not valid for sequence files, please refer to the documentation "
193 "of sequence_file_output::field_ids for the accepted values.");
195 static_assert([] () constexpr
201 "You may not select field::seq_qual and either of field::seq and field::qual at the same time.");
219 using iterator = detail::out_file_iterator<sequence_file_output>;
261 primary_stream->rdbuf()->pubsetbuf(stream_buffer.
data(), stream_buffer.
size());
263 std::ios_base::out | std::ios::binary);
265 if (!primary_stream->good())
266 throw file_open_error{
"Could not open file " + filename.
string() +
" for writing."};
269 secondary_stream = detail::make_secondary_ostream(*primary_stream, filename);
272 detail::set_format(format, filename);
290 template <output_stream stream_t,
293 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
stream_char_type>
296 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
298 primary_stream{&stream, stream_deleter_noop},
299 secondary_stream{&stream, stream_deleter_noop},
300 format{detail::sequence_file_output_format_exposer<file_format>{}}
302 static_assert(list_traits::contains<file_format, valid_formats>,
303 "You selected a format that is not in the valid_formats of this file.");
307 template <output_stream stream_t,
310 requires std::same_as<typename std::remove_reference_t<stream_t>::char_type,
stream_char_type>
313 file_format
const & SEQAN3_DOXYGEN_ONLY(format_tag),
315 primary_stream{
new stream_t{
std::move(stream)}, stream_deleter_default},
316 secondary_stream{&*primary_stream, stream_deleter_noop},
317 format{detail::sequence_file_output_format_exposer<file_format>{}}
319 static_assert(list_traits::contains<file_format, valid_formats>,
320 "You selected a format that is not in the valid_formats of this file.");
387 template <
typename record_t>
391 requires { requires detail::is_type_specialisation_of_v<std::remove_cvref_t<record_t>,
record>; }
394 write_record(detail::get_or_ignore<field::seq>(r),
395 detail::get_or_ignore<field::id>(r),
396 detail::get_or_ignore<field::qual>(r),
397 detail::get_or_ignore<field::seq_qual>(r));
422 template <
typename tuple_t>
429 write_record(detail::get_or_ignore<selected_field_ids::index_of(
field::seq)>(t),
430 detail::get_or_ignore<selected_field_ids::index_of(
field::id)>(t),
431 detail::get_or_ignore<selected_field_ids::index_of(field::qual)>(t),
432 detail::get_or_ignore<selected_field_ids::index_of(field::seq_qual)>(t));
458 template <
typename arg_t,
typename ...arg_types>
485 template <std::ranges::input_range rng_t>
491 for (
auto &&
record : range)
523 template <std::ranges::input_range rng_t>
534 template <std::ranges::input_range rng_t>
540 #if defined(__GNUC__) && (__GNUC__ == 9) // an unreported build problem of GCC9
541 for (
auto &&
record : range)
543 #else // ^^^ workaround | regular solution ↓↓↓
558 return *secondary_stream;
578 stream_ptr_t primary_stream{
nullptr, stream_deleter_noop};
580 stream_ptr_t secondary_stream{
nullptr, stream_deleter_noop};
583 using format_type =
typename detail::variant_from_tags<
valid_formats,
584 detail::sequence_file_output_format_exposer>::type;
590 template <
typename seq_t,
typename id_t,
typename qual_t,
typename seq_qual_t>
591 void write_record(seq_t &&
seq, id_t &&
id, qual_t && qual, seq_qual_t && seq_qual)
593 static_assert(detail::decays_to_ignore_v<seq_qual_t> ||
594 (detail::decays_to_ignore_v<seq_t> && detail::decays_to_ignore_v<qual_t>),
595 "You may not select field::seq_qual and either of field::seq and field::qual at the same time.");
597 if constexpr (!detail::decays_to_ignore_v<seq_qual_t>)
598 static_assert(detail::is_type_specialisation_of_v<std::ranges::range_value_t<seq_qual_t>, qualified>,
599 "The SEQ_QUAL field must contain a range over the seqan3::qualified alphabet.");
601 assert(!
format.valueless_by_exception());
604 if constexpr (!detail::decays_to_ignore_v<seq_qual_t>)
606 f.write_sequence_record(*secondary_stream,
608 seq_qual | views::get<0>,
610 seq_qual | views::get<1>);
614 f.write_sequence_record(*secondary_stream,
632 template <output_stream stream_t,
641 template <output_stream stream_t,
649 template <output_stream stream_t,
659 template <output_stream stream_t,
void reference
The reference type (void).
Definition: output.hpp:211
Provides seqan3::views::zip.
sequence_file_output_options options
The options are public and its members can be set directly.
Definition: output.hpp:551
Provides algorithms for meta programming, parameter packs and seqan3::type_list.
Provides various utility functions required only for output.
meta::list< types... > type_list
Type that contains multiple types, an alias for meta::list.
Definition: type_list.hpp:31
Provides seqan3::tuple_like.
sequence_file_output & operator=(rng_t &&range)
Write a range of records (or tuples) to the file.
Definition: output.hpp:486
void value_type
The value type (void).
Definition: output.hpp:209
Provides seqan3::views::convert.
@ id
The identifier, usually a string.
iterator begin() noexcept
Returns an iterator to current position in the file.
Definition: output.hpp:345
Provides the seqan3::record template and the seqan3::field enum.
This header includes C++17 filesystem support and imports it into namespace std::filesystem (independ...
valid_formats_ valid_formats
A seqan3::type_list with the possible formats.
Definition: output.hpp:177
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...
constexpr bool contains
Whether a type occurs in a pack or not.
Definition: traits.hpp:193
A class template that holds a choice of seqan3::field.
Definition: record.hpp:166
constexpr sequenced_policy seq
Global execution policy object for sequenced execution policy.
Definition: execution.hpp:54
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.
sequence_file_output(sequence_file_output &&)=default
Move construction is defaulted.
auto const move
A view that turns lvalue-references into rvalue-references.
Definition: move.hpp:68
sequence_file_output(sequence_file_output const &)=delete
Copy construction is explicitly deleted, because you can't have multiple access to the same file.
sentinel end() noexcept
Returns a sentinel for comparison with iterator.
Definition: output.hpp:364
std::default_sentinel_t sentinel
The type returned by end().
Definition: output.hpp:223
selected_field_ids_ selected_field_ids
A seqan3::fields list with the fields selected for the record.
Definition: output.hpp:175
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...
Provides exceptions used in the I/O module.
The main SeqAn3 namespace.
Definition: aligned_sequence_concept.hpp:29
A class for writing sequence files, e.g. FASTA, FASTQ ...
Definition: output.hpp:168
The options type defines various option members that influence the behaviour of all or some formats.
Definition: output_options.hpp:22
void push_back(tuple_t &&t)
Write a record in form of a std::tuple to the file.
Definition: output.hpp:423
Provides seqan3::sequence_file_output_options.
void const_reference
The const reference type (void).
Definition: output.hpp:213
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.
Whether a type behaves like a tuple.
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:295
Adaptations of concepts from the Ranges TS.
void emplace_back(arg_t &&arg, arg_types &&... args)
Write a record to the file by passing individual fields.
Definition: output.hpp:459
void const_iterator
The const iterator type is void, because files are not const-iterable.
Definition: output.hpp:221
detail::out_file_iterator< sequence_file_output > iterator
The iterator type of this view (an output iterator).
Definition: output.hpp:219
~sequence_file_output()=default
Destructor is defaulted.
void size_type
The size type (void).
Definition: output.hpp:215
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:524
void push_back(record_t &&r)
Write a seqan3::record to the file.
Definition: output.hpp:388
field
An enumerator for the fields used in file formats.
Definition: record.hpp:65
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:312
The class template that file records are based on; behaves like an std::tuple.
Definition: record.hpp:226
sequence_file_output()=delete
Default constructor is explicitly deleted, you need to give a stream or file name.
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.
char stream_char_type
Character type of the stream(s).
Definition: output.hpp:179
sequence_file_output & operator=(sequence_file_output &&)=default
Move assignment is defaulted.
Provides the seqan3::detail::out_file_iterator class template.
sequence_file_output(std::filesystem::path filename, selected_field_ids const &fields_tag=selected_field_ids{})
Construct from filename.
Definition: output.hpp:257
Provides various utility functions.
Provides traits for seqan3::type_list.
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:535
Provides seqan3::views::get.