Debug Stream

Provides core functionality used to print seqan3 and std types. More...

Collaboration diagram for Debug Stream:

Concepts
concept	seqan3::detail::debug_stream_range_guard
	A helper concept definition for ranges that can be streamed to the seqan3::debug_stream.

Classes
class	seqan3::debug_stream_type< char_t >
	A "pretty printer" for most SeqAn data structures and related types. More...
interface	debug_streamable_tuple
	A helper concept to avoid ambiguous overloads with the debug stream operator for alignments. More...

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
debug_stream_type	seqan3::debug_stream {std::cerr}
	A global instance of seqan3::debug_stream_type.
template<std::ranges::range rng_t, typename char_t >
constexpr bool	seqan3::detail::reference_type_is_streamable_v = false
	Helper template variable that checks if the reference type of a range can be streamed into an instance of seqan3::debug_stream_type .

Detailed Description

Provides core functionality used to print seqan3 and std types.

See also

Core

Enumeration Type Documentation

fmtflags2

enum seqan3::fmtflags2

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

See also

seqan3::enum_bitwise_operators enables combining enum values.

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

reference_type_is_streamable_v

template<std::ranges::range rng_t, typename char_t >

constexpr bool seqan3::detail::reference_type_is_streamable_v = false

constexpr

Helper template variable that checks if the reference type of a range can be streamed into an instance of seqan3::debug_stream_type .

Template Parameters

rng_t	The range type to check.
char_t	The char type of the stream.

Evaluates to true if the following expression is valid: debug_stream << *rng.begin();, where rng is of type rng_t. Otherwise false.