A class to read sequential binary data directly from an istream. More...

#include "streamReader.h"

Public Member Functions
	StreamReader (std::istream &in)

	StreamReader (std::istream *in, bool owns_stream)
	If owns_stream is true, the stream pointer will be deleted when the StreamReader destructs. More...

	StreamReader (const StreamReader &copy)
	The copy constructor does not copy ownership of the stream. More...

size_t	extract_bytes (unsigned char *into, size_t size)
	Extracts the indicated number of bytes in the stream into the given character buffer. More...

vector_uchar	extract_bytes (size_t size)
	Extracts the indicated number of bytes in the stream and returns them as a string. More...

float	get_be_float32 ()
	Extracts a 32-bit single-precision big-endian floating-point number. More...

PN_float64	get_be_float64 ()
	Extracts a 64-bit big-endian floating-point number. More...

int16_t	get_be_int16 ()
	Extracts a signed big-endian 16-bit integer. More...

int32_t	get_be_int32 ()
	Extracts a signed big-endian 32-bit integer. More...

int64_t	get_be_int64 ()
	Extracts a signed big-endian 64-bit integer. More...

uint16_t	get_be_uint16 ()
	Extracts an unsigned big-endian 16-bit integer. More...

uint32_t	get_be_uint32 ()
	Extracts an unsigned big-endian 32-bit integer. More...

uint64_t	get_be_uint64 ()
	Extracts an unsigned big-endian 64-bit integer. More...

bool	get_bool ()
	Extracts a boolean value. More...

std::string	get_fixed_string (size_t size)
	Extracts a fixed-length string. More...

float	get_float32 ()
	Extracts a 32-bit single-precision floating-point number. More...

PN_float64	get_float64 ()
	Extracts a 64-bit floating-point number. More...

int16_t	get_int16 ()
	Extracts a signed 16-bit integer. More...

int32_t	get_int32 ()
	Extracts a signed 32-bit integer. More...

int64_t	get_int64 ()
	Extracts a signed 64-bit integer. More...

int8_t	get_int8 ()
	Extracts a signed 8-bit integer. More...

std::istream *	get_istream () const

std::string	get_string ()
	Extracts a variable-length string. More...

std::string	get_string32 ()
	Extracts a variable-length string with a 32-bit length field. More...

uint16_t	get_uint16 ()
	Extracts an unsigned 16-bit integer. More...

uint32_t	get_uint32 ()
	Extracts an unsigned 32-bit integer. More...

uint64_t	get_uint64 ()
	Extracts an unsigned 64-bit integer. More...

uint8_t	get_uint8 ()
	Extracts an unsigned 8-bit integer. More...

std::string	get_z_string ()
	Extracts a variable-length string, as a NULL-terminated string. More...

void	operator= (const StreamReader &copy)
	The copy constructor does not copy ownership of the stream. More...

std::string	readline ()
	Assumes the stream represents a text file, and extracts one line up to and including the trailing newline character. More...

void	skip_bytes (size_t size)
	Skips over the indicated number of bytes in the stream. More...

Public Attributes
	get_istream
	Returns the stream in use. More...

Detailed Description

A class to read sequential binary data directly from an istream.

Its interface is similar to DatagramIterator by design; see also StreamWriter.

Definition at line 28 of file streamReader.h.

Constructor & Destructor Documentation

◆ StreamReader() [1/2]

StreamReader::StreamReader	(	std::istream *	in,
		bool	owns_stream
	)

inlineexplicit

If owns_stream is true, the stream pointer will be deleted when the StreamReader destructs.

Definition at line 29 of file streamReader.I.

◆ StreamReader() [2/2]

StreamReader::StreamReader ( const StreamReader & copy )

inline

The copy constructor does not copy ownership of the stream.

Definition at line 39 of file streamReader.I.

Member Function Documentation

◆ extract_bytes() [1/2]

size_t StreamReader::extract_bytes	(	unsigned char *	into,
		size_t	size
	)

Extracts the indicated number of bytes in the stream into the given character buffer.

Assumes that the buffer is big enough to hold the requested number of bytes. Returns the number of bytes that were successfully written.

Definition at line 120 of file streamReader.cxx.

◆ extract_bytes() [2/2]

vector_uchar StreamReader::extract_bytes ( size_t size )

Extracts the indicated number of bytes in the stream and returns them as a string.

Returns empty string at end-of-file.

Definition at line 134 of file streamReader.cxx.

◆ get_be_float32()

float StreamReader::get_be_float32 ( )

inline

Extracts a 32-bit single-precision big-endian floating-point number.

Since this kind of float is not necessarily portable across different architectures, special care is required.

Definition at line 280 of file streamReader.I.

◆ get_be_float64()

PN_float64 StreamReader::get_be_float64 ( )

inline

Extracts a 64-bit big-endian floating-point number.

Definition at line 297 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_be_int16()

int16_t StreamReader::get_be_int16 ( )

inline

Extracts a signed big-endian 16-bit integer.

Definition at line 206 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_be_int32()

int32_t StreamReader::get_be_int32 ( )

inline

Extracts a signed big-endian 32-bit integer.

Definition at line 218 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_be_int64()

int64_t StreamReader::get_be_int64 ( )

inline

Extracts a signed big-endian 64-bit integer.

Definition at line 230 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_be_uint16()

uint16_t StreamReader::get_be_uint16 ( )

inline

Extracts an unsigned big-endian 16-bit integer.

Definition at line 242 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_be_uint32()

uint32_t StreamReader::get_be_uint32 ( )

inline

Extracts an unsigned big-endian 32-bit integer.

Definition at line 254 of file streamReader.I.

References ReversedNumericData::store_value().

Referenced by HashVal::input_binary().

◆ get_be_uint64()

uint64_t StreamReader::get_be_uint64 ( )

inline

Extracts an unsigned big-endian 64-bit integer.

Definition at line 266 of file streamReader.I.

References ReversedNumericData::store_value().

◆ get_bool()

bool StreamReader::get_bool ( )

inline

Extracts a boolean value.

Definition at line 79 of file streamReader.I.

References get_uint8().

◆ get_fixed_string()

string StreamReader::get_fixed_string ( size_t size )

Extracts a fixed-length string.

However, if a zero byte occurs within the string, it marks the end of the string.

Definition at line 82 of file streamReader.cxx.

◆ get_float32()

float StreamReader::get_float32 ( )

inline

Extracts a 32-bit single-precision floating-point number.

Since this kind of float is not necessarily portable across different architectures, special care is required.

Definition at line 177 of file streamReader.I.

◆ get_float64()

PN_float64 StreamReader::get_float64 ( )

inline

Extracts a 64-bit floating-point number.

Definition at line 194 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_int16()

int16_t StreamReader::get_int16 ( )

inline

Extracts a signed 16-bit integer.

Definition at line 103 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_int32()

int32_t StreamReader::get_int32 ( )

inline

Extracts a signed 32-bit integer.

Definition at line 115 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_int64()

int64_t StreamReader::get_int64 ( )

inline

Extracts a signed 64-bit integer.

Definition at line 127 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_int8()

int8_t StreamReader::get_int8 ( )

inline

Extracts a signed 8-bit integer.

Definition at line 87 of file streamReader.I.

◆ get_string()

string StreamReader::get_string ( )

Extracts a variable-length string.

Definition at line 24 of file streamReader.cxx.

◆ get_string32()

string StreamReader::get_string32 ( )

Extracts a variable-length string with a 32-bit length field.

Definition at line 43 of file streamReader.cxx.

◆ get_uint16()

uint16_t StreamReader::get_uint16 ( )

inline

Extracts an unsigned 16-bit integer.

Definition at line 139 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_uint32()

uint32_t StreamReader::get_uint32 ( )

inline

Extracts an unsigned 32-bit integer.

Definition at line 151 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_uint64()

uint64_t StreamReader::get_uint64 ( )

inline

Extracts an unsigned 64-bit integer.

Definition at line 163 of file streamReader.I.

References NativeNumericData::store_value().

◆ get_uint8()

uint8_t StreamReader::get_uint8 ( )

inline

Extracts an unsigned 8-bit integer.

Definition at line 95 of file streamReader.I.

Referenced by get_bool().

◆ get_z_string()

string StreamReader::get_z_string ( )

Extracts a variable-length string, as a NULL-terminated string.

Definition at line 64 of file streamReader.cxx.

◆ operator=()

void StreamReader::operator= ( const StreamReader & copy )

inline

The copy constructor does not copy ownership of the stream.

Definition at line 49 of file streamReader.I.

◆ readline()

string StreamReader::readline ( )

Assumes the stream represents a text file, and extracts one line up to and including the trailing newline character.

Returns empty string when the end of file is reached.

The interface here is intentionally designed to be similar to that for Python's File.readline() function.

Definition at line 156 of file streamReader.cxx.

◆ skip_bytes()

void StreamReader::skip_bytes ( size_t size )

Skips over the indicated number of bytes in the stream.

Definition at line 102 of file streamReader.cxx.

Referenced by WavAudioCursor::seek().

Member Data Documentation

◆ get_istream

std::istream * StreamReader::get_istream

inline

Returns the stream in use.

Definition at line 38 of file streamReader.h.

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

dtool/src/prc/streamReader.h
dtool/src/prc/streamReader.cxx
dtool/src/prc/streamReader.I

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ StreamReader() [1/2]

◆ StreamReader() [2/2]

Member Function Documentation

◆ extract_bytes() [1/2]

◆ extract_bytes() [2/2]

◆ get_be_float32()

◆ get_be_float64()

◆ get_be_int16()

◆ get_be_int32()

◆ get_be_int64()

◆ get_be_uint16()

◆ get_be_uint32()

◆ get_be_uint64()

◆ get_bool()

◆ get_fixed_string()

◆ get_float32()

◆ get_float64()

◆ get_int16()

◆ get_int32()

◆ get_int64()

◆ get_int8()

◆ get_string()

◆ get_string32()

◆ get_uint16()

◆ get_uint32()

◆ get_uint64()

◆ get_uint8()

◆ get_z_string()

◆ operator=()

◆ readline()

◆ skip_bytes()

Member Data Documentation

◆ get_istream