SeqAn3
seqan3::stream_concept Interface Reference

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...

#include <seqan3/io/stream/concept.hpp>

Inheritance diagram for seqan3::stream_concept:
[legend]

Requirements for seqan3::ostream_concept

You can expect these member types and the free function on all types that satisfy seqan3::ostream_concept.

std::basic_ostream< char_type, traits_type > & operator<< (value_type val)
 (un)-formatted output operator for the respective type on the underlying stream. More...
 
typename stream::char_type char_type
 Declares the associated char type.
 
typename stream::traits_type traits_type
 Declares the associated traits type.
 
typename stream::int_type int_type
 Declares the associated int type.
 
typename stream::pos_type pos_type
 Declares the associated pos type.
 
typename stream::off_type off_type
 Declares the associated off type.
 

Requirements for seqan3::istream_concept

You can expect these member types and the free function on all types that satisfy seqan3::istream_concept.

std::basic_istream< char_type, traits_type > & operator>> (value_type val)
 (un)-formatted input operator for the respective type on the underlying stream. More...
 
typename stream::char_type char_type
 Declares the associated char type.
 
typename stream::traits_type traits_type
 Declares the associated traits type.
 
typename stream::int_type int_type
 Declares the associated int type.
 
typename stream::pos_type pos_type
 Declares the associated pos type.
 
typename stream::off_type off_type
 Declares the associated off type.
 

Detailed Description

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.

Friends And Related Function Documentation

◆ operator<<()

std::basic_ostream< char_type, traits_type > & operator<< ( value_type  val)
related

(un)-formatted output operator for the respective type on the underlying stream.

Parameters
valThe value to write into the stream.
Returns
A reference to a std::basic_ostream<char_type, traits_type>.

The char_type and traits_type are inferred from the given ostream.

Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

◆ operator>>()

std::basic_istream< char_type, traits_type > & operator>> ( value_type  val)
related

(un)-formatted input operator for the respective type on the underlying stream.

Parameters
valThe value to read from the stream.
Returns
A reference to a std::basic_istream<char_type, traits_type>.

The char_type and traits_type are inferred from the given istream.

Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

The documentation for this interface was generated from the following file: