Streams.hpp File Reference

File containing definitions of InputStream, OutputStream, CompressedInputStream, and CompressedOutputStream. More...

#include "cgatools/core.hpp"
#include "cgatools/util/Exception.hpp"
#include <boost/shared_ptr.hpp>
#include <boost/iostreams/stream.hpp>
#include <boost/iostreams/filtering_stream.hpp>

Go to the source code of this file.

Classes
class	cgatools::util::FileDescriptorDevice
struct	cgatools::util::FileDescriptorDevice::category
struct	cgatools::util::FileDescriptorDevice::impl
struct	cgatools::util::FileSourceDevice
struct	cgatools::util::FileSourceDevice::category
struct	cgatools::util::FileSinkDevice
struct	cgatools::util::FileSinkDevice::category
class	cgatools::util::InputStream
	A std::istream with good error messages. More...
class	cgatools::util::OutputStream
	a std::ostream with good error messages, and which does fsync on close on UNIX. More...
class	cgatools::util::CompressedInputStream
class	cgatools::util::CompressedOutputStream
Namespaces
namespace	cgatools
	Namespace containing the libcgatools API.
namespace	cgatools::util
	Namespace for general-purpose utilities.
Defines
#define	CGATOOLS_UTIL_STREAMS_HPP_   1
Functions
void	cgatools::util::writeBinaryBool (std::ostream &out, bool val)
	Writes a '\0' for false or '\001' for true.
template<class IntType >
void	cgatools::util::writeBinaryInt (std::ostream &out, IntType val)
	Writes the integer out in msb -> lsb order.
template<class IntType >
void	cgatools::util::writeBinaryUIntZC (std::ostream &out, IntType val)
	Writes the integer out in "zero-compressed" format, suitable for reading in by cgatools::util::readBinaryUIntZC().
void	cgatools::util::writeBinaryString (std::ostream &out, const std::string &val)
	Writes the string out in a binary format, suitable for reading in by cgatools::util::readBinaryString().
void	cgatools::util::readBinaryBool (std::istream &in, bool *val)
	Reads one byte interpreted as a boolean, such that 0 is false and anything else is true.
template<class IntType >
void	cgatools::util::readBinaryInt (std::istream &in, IntType *pVal)
	Reads the integer in msb -> lsb order.
template<class IntType >
void	cgatools::util::readBinaryUIntZC (std::istream &in, IntType *pVal)
	Reads an integer stored in "zero-compressed" format.
void	cgatools::util::readBinaryString (std::istream &in, std::string *val)
	Reads the string written out by cgatools::util::writeBinaryString().

---

Detailed Description

File containing definitions of InputStream, OutputStream, CompressedInputStream, and CompressedOutputStream.