Stream

The stream sub-module contains data structures and functions for streaming and tokenization. More...

Collaboration diagram for Stream:

Classes
class	seqan3::debug_stream_type
	A "pretty printer" for most SeqAn data structures and related types. More...
interface	seqan3::IStream
	Concept for input streams. More...
interface	seqan3::OStream
	Concept for output streams. More...
interface	seqan3::Stream
	Concept for i/o streams permitting both directions.An object satisfying the requirements of a stream concept can be used to stream in both (input and output) directions. More...

Typedefs
using	seqan3::ostream_iterator = ::ranges::ostream_iterator
	Alias for ranges::ostream_iterator. Writes successive elements onto the output stream from which it was constructed.
using	seqan3::ostreambuf_iterator = ::ranges::ostreambuf_iterator
	Alias for ranges::ostreambuf_iterator. Writes successive characters onto the output stream from which it was constructed.

Enumerations
enum	seqan3::fmtflags2 { seqan3::none = 0, seqan3::utf8 = 1, seqan3::small_int_as_number = 1 << 1, default_ = small_int_as_number }
	Flags that change the behaviour of the seqan3::debug_stream. More...

Variables
template<char op, typename condition_head_t , typename ... condition_ts>
small_string constexpr	condition_message_v
	Defines a compound seqan3::small_string consisting of all given conditions separated by the operator-name op. More...
debug_stream_type	seqan3::debug_stream {}
	A global instance of seqan3::debug_stream_type.

Detailed Description

The stream sub-module contains data structures and functions for streaming and tokenization.

Enumeration Type Documentation

fmtflags2

enum seqan3::fmtflags2

Flags that change the behaviour of the seqan3::debug_stream.

Enumerator
none	No flag is set.
utf8	Enables use of non-ASCII UTF8 characters in formatted output.
small_int_as_number	int8_t and uint8_t are often aliases for signed char and unsigned char resp. resulting in chars being printed; this options prints them as numbers.

Variable Documentation

condition_message_v

template<char op, typename condition_head_t , typename ... condition_ts>

small_string constexpr condition_message_v

inline

Initial value:

{
    small_string{"("} +
    (condition_head_t::msg + ... +
        (small_string{" "} + small_string{{op, op, '\0'}} + small_string{" "} + condition_ts::msg)) +
    small_string{")"}
}

Defines a compound seqan3::small_string consisting of all given conditions separated by the operator-name op.

Template Parameters

op	non-type template parameter specifying the separator character, e.g. '|'.
condition_head_t	The first condition type in the message. Ensures that there is at least one type.
condition_ts	Remaining list of conditions separated by op.