icstream: Input channel stream wrapper class More...

#include <icstream.hh>

Inheritance diagram for utility::io::icstream:

Public Member Functions
	icstream (std::istream &i_stream_a)
	Constructor. More...

	operator bool () const override
	bool conversion More...

	operator std::istream const & () const override
	Stream conversion. More...

	operator std::istream & () override
	Stream conversion. More...

template<typename T >
icstream &	operator>> (T &t)
	Stream input: Override to preserve type of return value. More...

std::istream &	operator>> (std_manipulator m) override
	Stream manipulator input. More...

void	seek_beg () override
	Seek to the beginning. More...

int	get () override
	Get the next character. More...

icstream &	get (char &c) override
	Get the next character. More...

icstream &	get (char *str, std::streamsize const count) override
	Get the next specified number of characters. More...

icstream &	get (char *str, std::streamsize const count, char const delim) override
	Get the next specified number of characters. More...

icstream &	get (std::string &str, std::streamsize const count) override
	Get the next specified number of characters. More...

icstream &	get (std::string &str, std::streamsize const count, char const delim) override
	Get the next specified number of characters. More...

icstream &	getline (char *line, std::streamsize const count) override
	Get the rest of the line. More...

icstream &	getline (char *line, std::streamsize const count, char const delim) override
	Get the rest of the line. More...

icstream &	getline (std::string &line) override
	Get the rest of the line. More...

icstream &	getline (std::string &line, char const delim) override
	Get the rest of the line. More...

icstream &	read (char *str, std::streamsize const count) override
	Read the next specified number of characters. More...

icstream &	read (std::string &str, std::streamsize const count) override
	Read the next specified number of characters. More...

std::streamsize	readsome (char *str, std::streamsize const count) override
	Read the next available specified number of characters. More...

std::streamsize	readsome (std::string &str, std::streamsize const count) override
	Read the next available specified number of characters. More...

icstream &	ignore () override
	Skip over the next character. More...

icstream &	ignore (std::streamsize const count) override
	Skip over the next specified number of characters. More...

icstream &	ignore (std::streamsize const count, char const delim) override
	Skip over the next specified number of characters. More...

int	peek () override
	Returns the next character without extracting it. More...

icstream &	unget () override
	Put the last character read back into the stream. More...

icstream &	putback (char c) override
	Put the last character read back into the stream and check that passed character is correct. More...

void	clear () override
	Clear the stream. More...

std::istream const &	operator() () const override
	Stream access. More...

std::istream &	operator() () override
	Stream access. More...

std::istream const &	stream () const override
	Stream access. More...

std::istream &	stream () override
	Stream access. More...

std::streambuf *	rdbuf () const override
	Pointer to the stream buffer. More...

bool	good () const override
	Good? More...

bool	eof () const override
	End of file? More...

bool	fail () const override
	Fail? More...

bool	bad () const override
	Bad? More...

bool	compressed () const override
	Compressed? More...

bool	uncompressed () const override
	Uncompressed? More...

bool	gzipped () const override
	gzipped? More...

Public Member Functions inherited from utility::io::irstream
virtual	~irstream ()
	Destructor. More...

template<typename T >
irstream &	operator>> (T &t)
	Stream input. More...

Private Attributes
std::istream &	i_stream_
	Input stream reference. More...

Additional Inherited Members
Protected Types inherited from utility::io::irstream
typedef std::istream &(*	std_manipulator) (std::istream &)

Protected Member Functions inherited from utility::io::irstream
	irstream ()=default
	Default constructor. More...

Detailed Description

icstream: Input channel stream wrapper class

Constructor & Destructor Documentation

◆ icstream()

utility::io::icstream::icstream ( std::istream & i_stream_a )

inline

Constructor.

Member Function Documentation

◆ bad()

bool utility::io::icstream::bad ( ) const

inlineoverridevirtual

Bad?

Implements utility::io::irstream.

References i_stream_.

◆ clear()

void utility::io::icstream::clear ( )

inlineoverridevirtual

Clear the stream.

Implements utility::io::irstream.

References i_stream_.

Referenced by utility::signals::PausableSignalHub< ReturnType, Signal >::after_send(), and pyrosetta.bindings.pose.ResidueLabelAccessor::discard().

◆ compressed()

bool utility::io::icstream::compressed ( ) const

inlineoverridevirtual

Compressed?

Implements utility::io::irstream.

Referenced by pyrosetta.distributed.cluster.io.IO::_save_results().

◆ eof()

bool utility::io::icstream::eof ( ) const

inlineoverridevirtual

End of file?

Implements utility::io::irstream.

References i_stream_.

◆ fail()

bool utility::io::icstream::fail ( ) const

inlineoverridevirtual

Fail?

Implements utility::io::irstream.

References i_stream_.

◆ get() [1/6]

int utility::io::icstream::get ( )

inlineoverridevirtual

Get the next character.

Implements utility::io::irstream.

References stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ get() [2/6]

icstream& utility::io::icstream::get ( char & c )

inlineoverridevirtual

Get the next character.

Implements utility::io::irstream.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::c, and stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ get() [3/6]

icstream& utility::io::icstream::get	(	char *	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References count, str(), and stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ get() [4/6]

icstream& utility::io::icstream::get	(	char *	str,
		std::streamsize const	count,
		char const	delim
	)

inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References count, str(), and stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ get() [5/6]

icstream& utility::io::icstream::get	(	std::string &	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References count, basic::options::OptionKeys::cp::cp, str(), and stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ get() [6/6]

icstream& utility::io::icstream::get	(	std::string &	str,
		std::streamsize const	count,
		char const	delim
	)

inlineoverridevirtual

Get the next specified number of characters.

Implements utility::io::irstream.

References count, basic::options::OptionKeys::cp::cp, str(), and stream().

Referenced by pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::emit(), pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::pop_masked_key(), and pyrosetta.distributed.cluster.logging_handlers.MultiSocketHandler::set_masked_key().

◆ getline() [1/4]

icstream& utility::io::icstream::getline	(	char *	line,
		std::streamsize const	count
	)

inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References count, line, and stream().

◆ getline() [2/4]

icstream& utility::io::icstream::getline	(	char *	line,
		std::streamsize const	count,
		char const	delim
	)

inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References count, line, and stream().

◆ getline() [3/4]

icstream& utility::io::icstream::getline ( std::string & line )

inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References getline(), line, and stream().

◆ getline() [4/4]

icstream& utility::io::icstream::getline	(	std::string &	line,
		char const	delim
	)

inlineoverridevirtual

Get the rest of the line.

Implements utility::io::irstream.

References getline(), line, and stream().

◆ good()

bool utility::io::icstream::good ( ) const

inlineoverridevirtual

Good?

Implements utility::io::irstream.

References i_stream_.

◆ gzipped()

bool utility::io::icstream::gzipped ( ) const

inlineoverridevirtual

gzipped?

Implements utility::io::irstream.

◆ ignore() [1/3]

icstream& utility::io::icstream::ignore ( )

inlineoverridevirtual

Skip over the next character.

Implements utility::io::irstream.

References stream().

◆ ignore() [2/3]

icstream& utility::io::icstream::ignore ( std::streamsize const count )

inlineoverridevirtual

Skip over the next specified number of characters.

Implements utility::io::irstream.

References count, and stream().

◆ ignore() [3/3]

icstream& utility::io::icstream::ignore	(	std::streamsize const	count,
		char const	delim
	)

inlineoverridevirtual

Skip over the next specified number of characters.

Implements utility::io::irstream.

References count, and stream().

◆ operator bool()

utility::io::icstream::operator bool ( ) const

inlineoverridevirtual

bool conversion

Implements utility::io::irstream.

References i_stream_.

◆ operator std::istream &()

utility::io::icstream::operator std::istream & ( )

inlineoverridevirtual

Stream conversion.

Implements utility::io::irstream.

References i_stream_.

◆ operator std::istream const &()

utility::io::icstream::operator std::istream const & ( ) const

inlineoverridevirtual

Stream conversion.

Implements utility::io::irstream.

References i_stream_.

◆ operator()() [1/2]

std::istream const& utility::io::icstream::operator() ( ) const

inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

◆ operator()() [2/2]

std::istream& utility::io::icstream::operator() ( )

inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

◆ operator>>() [1/2]

std::istream& utility::io::icstream::operator>> ( std_manipulator m )

inlineoverridevirtual

Stream manipulator input.

Implements utility::io::irstream.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::m.

◆ operator>>() [2/2]

template<typename T >

icstream& utility::io::icstream::operator>> ( T & t )

inline

Stream input: Override to preserve type of return value.

References i_stream_, and predPRE::t.

◆ peek()

int utility::io::icstream::peek ( )

inlineoverridevirtual

Returns the next character without extracting it.

Implements utility::io::irstream.

References stream().

◆ putback()

icstream& utility::io::icstream::putback ( char c )

inlineoverridevirtual

Put the last character read back into the stream and check that passed character is correct.

Implements utility::io::irstream.

References kmeans_adaptive_kernel_density_bb_dependent_rotlib::c, and stream().

◆ rdbuf()

std::streambuf* utility::io::icstream::rdbuf ( ) const

inlineoverridevirtual

Pointer to the stream buffer.

Implements utility::io::irstream.

References i_stream_.

◆ read() [1/2]

icstream& utility::io::icstream::read	(	char *	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Read the next specified number of characters.

Implements utility::io::irstream.

References count, str(), and stream().

◆ read() [2/2]

icstream& utility::io::icstream::read	(	std::string &	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Read the next specified number of characters.

Implements utility::io::irstream.

References count, basic::options::OptionKeys::cp::cp, str(), and stream().

◆ readsome() [1/2]

std::streamsize utility::io::icstream::readsome	(	char *	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Read the next available specified number of characters.

Implements utility::io::irstream.

References count, str(), and stream().

◆ readsome() [2/2]

std::streamsize utility::io::icstream::readsome	(	std::string &	str,
		std::streamsize const	count
	)

inlineoverridevirtual

Read the next available specified number of characters.

Implements utility::io::irstream.

References count, basic::options::OptionKeys::cp::cp, str(), and stream().

◆ seek_beg()

void utility::io::icstream::seek_beg ( )

inlineoverridevirtual

Seek to the beginning.

Implements utility::io::irstream.

References stream().

◆ stream() [1/2]

std::istream const& utility::io::icstream::stream ( ) const

inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

Referenced by get(), getline(), ignore(), peek(), putback(), read(), readsome(), seek_beg(), and unget().

◆ stream() [2/2]

std::istream& utility::io::icstream::stream ( )

inlineoverridevirtual

Stream access.

Implements utility::io::irstream.

References i_stream_.

◆ uncompressed()

bool utility::io::icstream::uncompressed ( ) const

inlineoverridevirtual

Uncompressed?

Implements utility::io::irstream.

◆ unget()

icstream& utility::io::icstream::unget ( )

inlineoverridevirtual

Put the last character read back into the stream.

Implements utility::io::irstream.

References stream().

Member Data Documentation

◆ i_stream_

std::istream& utility::io::icstream::i_stream_

private

Input stream reference.

Referenced by bad(), clear(), eof(), fail(), good(), operator bool(), operator std::istream &(), operator std::istream const &(), operator()(), operator>>(), rdbuf(), and stream().

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

src/utility/io/icstream.hh

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ icstream()

Member Function Documentation

◆ bad()

◆ clear()

◆ compressed()

◆ eof()

◆ fail()

◆ get() [1/6]

◆ get() [2/6]

◆ get() [3/6]

◆ get() [4/6]

◆ get() [5/6]

◆ get() [6/6]

◆ getline() [1/4]

◆ getline() [2/4]

◆ getline() [3/4]

◆ getline() [4/4]

◆ good()

◆ gzipped()

◆ ignore() [1/3]

◆ ignore() [2/3]

◆ ignore() [3/3]

◆ operator bool()

◆ operator std::istream &()

◆ operator std::istream const &()

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ operator>>() [1/2]

◆ operator>>() [2/2]

◆ peek()

◆ putback()

◆ rdbuf()

◆ read() [1/2]

◆ read() [2/2]

◆ readsome() [1/2]

◆ readsome() [2/2]

◆ seek_beg()

◆ stream() [1/2]

◆ stream() [2/2]

◆ uncompressed()

◆ unget()

Member Data Documentation

◆ i_stream_