byteme Namespace Reference

Simple byte readers and writers. More...

Classes
class	ChunkedBufferReader
	Read chunks of bytes from a raw buffer. More...
class	GzipFileReader
	Read uncompressed bytes from a Gzip-compressed file. More...
struct	GzipFileReaderOptions
	Options for GzipFileReader construction. More...
class	GzipFileWriter
	Write uncompressed bytes to a Gzip-compressed file. More...
struct	GzipFileWriterOptions
	Options for GzipFileWriter construction. More...
class	IstreamReader
	Read bytes from a std::istream. More...
struct	IstreamReaderOptions
	Options for IstreamReader construction. More...
class	OstreamWriter
	Read bytes from a std::ostream. More...
class	PerByteInterface
	Interface for byte-by-byte extraction from a Reader source. More...
class	PerByteParallel
	Parallelized byte-by-byte extraction from a Reader source. More...
class	PerByteSerial
	Serial byte-by-byte extraction from a Reader source. More...
class	RawBufferReader
	Read bytes from a raw buffer, usually text. More...
class	RawBufferWriter
	Write bytes to a raw buffer. More...
struct	RawBufferWriterOptions
	Options for the RawBufferWriter constructor. More...
class	RawFileReader
	Read bytes from a file, usually text. More...
struct	RawFileReaderOptions
	Options for the RawFileReader constructor. More...
class	RawFileWriter
	Write bytes to a file. More...
struct	RawFileWriterOptions
	Options for the RawFileWriter constructor. More...
class	Reader
	Virtual class for reading bytes from a source. More...
class	SomeBufferReader
	Read a buffer that may or may not be Gzip/Zlib-compressed. More...
struct	SomeBufferReaderOptions
	Options for the SomeBufferReader constructor. More...
class	SomeFileReader
	Read a file that may or may not be Gzipped. More...
struct	SomeFileReaderOptions
	Options for the SomeFileReader constructor. More...
class	Writer
	Virtual class for writing bytes to a sink. More...
class	ZlibBufferReader
	Read and decompress bytes from a Zlib-compressed buffer. More...
struct	ZlibBufferReaderOptions
	Options for the ZlibBufferReader constructor. More...
class	ZlibBufferWriter
	Compress and write bytes to a Zlib-compressed buffer. More...
struct	ZlibBufferWriterOptions
	Options for the ZlibBufferWriter constructor. More...

Functions
template<typename Output_ , typename Size_ >
constexpr Output_	cap (Size_ size)

Detailed Description

Simple byte readers and writers.

Function Documentation

cap()

template<typename Output_ , typename Size_ >

Output_ byteme::cap ( Size_ size )

constexpr

Cap an input integer at the largest value that can be represented by a specified output type, typically a std::size_t. This avoids silent integer overflows, especially in the defaults of the various *Options classes.

Template Parameters

Output_	Unsigned integer type of the output.
Input_	Integer type of the input.

Parameters

size	Non-negative integer specifying some kind of buffer size.

Returns

size if it fits in an Output_, otherwise the largest value of an Output_.