SeqAn3 3.4.0-rc.1
The Modern C++ library for sequence analysis.
Loading...
Searching...
No Matches
seqan3::detail::ignore_output_iterator Class Reference

An output iterator that emulates writing to a null-stream in order to dispose the output. More...

#include <seqan3/io/detail/ignore_output_iterator.hpp>

Public Types

Member types

Associated types are void for output iterators, see also output iterator concept.

using value_type = void
 The value type (void).
 
using reference = void
 The reference type (void).
 
using pointer = void
 The pointer type (void).
 
using difference_type = std::ptrdiff_t
 A signed integer type, usually std::ptrdiff_t.
 
using iterator_category = std::output_iterator_tag
 The iterator category type.
 

Public Member Functions

Constructors, destructor and assignment
 ignore_output_iterator ()=default
 Defaulted.
 
 ignore_output_iterator (ignore_output_iterator const &)=default
 Defaulted.
 
 ignore_output_iterator (ignore_output_iterator &&)=default
 Defaulted.
 
ignore_output_iteratoroperator= (ignore_output_iterator const &)=default
 Defaulted.
 
ignore_output_iteratoroperator= (ignore_output_iterator &&)=default
 Defaulted.
 
 ~ignore_output_iterator ()=default
 
Member functions

Each function performs no operation. In fact writing to the seqan3::detail::ignore_output_iterator, is subject to removal by compiler optimizations.

template<typename type >
constexpr ignore_output_iteratoroperator= (type const) noexcept
 Emulates writing the passed value to the null-stream.
 
constexpr ignore_output_iteratoroperator* () noexcept
 This operator performs no function in output iterators.
 
constexpr ignore_output_iteratoroperator++ () noexcept
 This operator performs no function in output iterators.
 
constexpr ignore_output_iteratoroperator++ (int) noexcept
 This operator performs no function in output iterators.
 

Detailed Description

An output iterator that emulates writing to a null-stream in order to dispose the output.

This helper iterator can be used to explicitly dispose output streams, i.e. the output data is transmitted nowhere. A typical use case is when extracted bytes from an input stream should be ignored, as they contain only structural information, e.g. a newline character.

Constructor & Destructor Documentation

◆ ~ignore_output_iterator()

seqan3::detail::ignore_output_iterator::~ignore_output_iterator ( )
default

Defaulted


The documentation for this class was generated from the following file:
Hide me