tudocomp
– The TU Dortmund Compression Framework
tdc::io Namespace Reference

Contains I/O abstractions and utilities. More...

Classes

class  BitIStream
 Wrapper for input streams that provides bitwise reading functionality. More...
 
class  BitOStream
 Wrapper for output streams that provides bitwise writing functionality. More...
 
struct  EscapeMap
 
class  FastEscapeMap
 
class  FastUnescapeMap
 
class  Input
 An abstraction layer for algorithm input. More...
 
class  InputRestrictions
 Describes a set of restrictions placed on input data. More...
 
class  InputSource
 Class that stores the source of input data. More...
 
class  InputStream
 Provides a character stream of the underlying input. More...
 
class  InputView
 Provides a view on the input that allows for random access. More...
 
class  Output
 An abstraction layer for algorithm output. More...
 
class  OutputStream
 Provides a character stream to the underlying output. More...
 
struct  Path
 Represents a file path. More...
 
class  RestrictedIStreamBuf
 Adapter class over a std::istream that escapes and null terminates the data read from it according to the provided input restrictions. More...
 
class  RestrictedOStreamBuf
 Adapter class over a std::ostream that reverse the escaping and null termination of data written to it according to the provided input restrictions. More...
 

Functions

std::ostream & operator<< (std::ostream &o, const InputRestrictions &v)
 
InputRestrictions operator| (const InputRestrictions &a, const InputRestrictions &b)
 Merges two InpuTrestrictions to a combined set of restrictions. More...
 
InputRestrictionsoperator|= (InputRestrictions &a, const InputRestrictions &b)
 Merges two InpuTrestrictions to a combined set of restrictions. More...
 
bool operator== (const InputRestrictions &lhs, const InputRestrictions &rhs)
 
bool operator!= (const InputRestrictions &lhs, const InputRestrictions &rhs)
 
bool operator== (const InputSource &lhs, const InputSource &rhs)
 
std::ostream & operator<< (std::ostream &o, const InputSource &v)
 
std::ostream & operator<< (std::ostream &o, const InputView &iv)
 
bool file_exists (const std::string &filename)
 

Detailed Description

Contains I/O abstractions and utilities.

All I/O done by compressors and encoders is routed through the Input and Output abstractions over the underlying file, memory or stream I/O.

See also
Input for the input interface and Output for the output interface.

Function Documentation

bool tdc::io::file_exists ( const std::string &  filename)
inline

Definition at line 110 of file IOUtil.hpp.

bool tdc::io::operator!= ( const InputRestrictions lhs,
const InputRestrictions rhs 
)
inline

Definition at line 94 of file InputRestrictions.hpp.

std::ostream& tdc::io::operator<< ( std::ostream &  o,
const InputView iv 
)
inline

Definition at line 54 of file InputView.hpp.

std::ostream& tdc::io::operator<< ( std::ostream &  o,
const InputRestrictions v 
)
inline

Definition at line 55 of file InputRestrictions.hpp.

std::ostream& tdc::io::operator<< ( std::ostream &  o,
const InputSource v 
)
inline

Definition at line 66 of file InputSource.hpp.

bool tdc::io::operator== ( const InputSource lhs,
const InputSource rhs 
)
inline

Definition at line 58 of file InputSource.hpp.

bool tdc::io::operator== ( const InputRestrictions lhs,
const InputRestrictions rhs 
)
inline

Definition at line 88 of file InputRestrictions.hpp.

InputRestrictions tdc::io::operator| ( const InputRestrictions a,
const InputRestrictions b 
)
inline

Merges two InpuTrestrictions to a combined set of restrictions.

Definition at line 64 of file InputRestrictions.hpp.

InputRestrictions& tdc::io::operator|= ( InputRestrictions a,
const InputRestrictions b 
)
inline

Merges two InpuTrestrictions to a combined set of restrictions.

Definition at line 83 of file InputRestrictions.hpp.