CppMate Namespace Reference

Namespaces
	BitOps
	Crc16
	Crc32
	EnumBitOps
	Forge
	String

Classes
class	BinaryData
	Represents interface of abstract binary data. More...
class	BinarySink
	Represents low-level interface of abstract binary sink. More...
class	Event
	Represents signal emitter with a specified event type. More...
class	FileReader
	Represents fast file reader with platform-dependent implementation. More...
class	FileWriter
	Represents file writer with platform-dependent implementation. More...
class	GenericBase
	The base class of some generics which type required to be detected in runtime. More...
class	Noncopyable
	Represent base class for uncopable instances. More...
class	Path
	Represents path. More...
class	ReadStream
	Represents the byte stream reader with custom byte order. More...
class	Resource
	Represents some abstract resource which should be released. More...
class	SharedState
	Represents shared state wrapper for thread pool tasks. More...
class	Signal
	Represents signal. More...
class	ThreadPool
	Represents thread pool. More...
class	Pipeline
	Represents abstract pipeline. More...
class	PipelineThreadPool
	Represents pipeline implemetation with ThreadPool backend. More...
class	WriteStream
	Represents the byte stream reader with custom byte order. More...

Enumerations
enum class	ByteOrder { Unknown , LittleEndian , BigEndian }
	The byte order type. More...

Functions
ByteOrder CPP_MATE_LIB_API	getNativeByteOrder ()
	Returns platform byte order. More...
template<typename T , typename... A>
void	check (bool condition, A &&... args)
	Throws exception T if the condition is false. More...
template<typename T >
void	checkError (bool condition, T error, const std::error_category &category, const char *message="")
	Throws std::system_error if the condition is false. More...
template<typename T >
ReadStream &	operator>> (ReadStream &stream, T &result)

Enumeration Type Documentation

ByteOrder

enum CppMate::ByteOrder

strong

The byte order type.

Enumerator
Unknown	Unknown byte order.
LittleEndian	Little endian.
BigEndian	Big endian.

Function Documentation

check()

template<typename T , typename... A>

void CppMate::check ( bool  condition, A &&...  args  )

inline

Throws exception T if the condition is false.

Parameters

condition	condition to check.
args	arguments to pass into exception constructor.

checkError()

template<typename T >

void CppMate::checkError ( bool  condition, T  error, const std::error_category &  category, const char *  message = ""  )

inline

Throws std::system_error if the condition is false.

Parameters

condition	condition to check.
error	error code to create std::error_code.
category	error category to create std::error_code.
message	optional 'what' message.

getNativeByteOrder()

ByteOrder CPP_MATE_LIB_API CppMate::getNativeByteOrder

(

)

Returns platform byte order.

Returns

platform byte order.

operator>>()

template<typename T >

ReadStream& CppMate::operator>> ( ReadStream &  stream, T &  result  )

inline

Parameters

stream	the read stream.
result	the result of read.

Returns

this