AudioDataLib::FileInputStream Class Reference

This is a file stream that can be used to read bytes from a file. More...

#include <ByteStream.h>

Inheritance diagram for AudioDataLib::FileInputStream:

Public Member Functions
	FileInputStream (const char *filePath)
virtual	~FileInputStream ()
virtual uint64_t	WriteBytesToStream (const uint8_t *buffer, uint64_t bufferSize) override
virtual uint64_t	ReadBytesFromStream (uint8_t *buffer, uint64_t bufferSize) override
virtual uint64_t	GetSize () const override
virtual bool	CanRead () override
virtual bool	CanWrite () override
Public Member Functions inherited from AudioDataLib::FileStream
	FileStream (const char *filePath, const char *mode)
virtual	~FileStream ()
bool	IsOpen ()
void	Close ()
Public Member Functions inherited from AudioDataLib::ByteStream
	ByteStream ()
virtual	~ByteStream ()
virtual uint64_t	PeekBytesFromStream (uint8_t *buffer, uint64_t bufferSize)
template<typename T >
bool	ReadType (T *value)
template<typename T >
bool	WriteType (const T *value)

Additional Inherited Members
Protected Attributes inherited from AudioDataLib::FileStream
FILE *	fp

Detailed Description

This is a file stream that can be used to read bytes from a file.

Constructor & Destructor Documentation

FileInputStream()

FileInputStream::FileInputStream

(

const char *

filePath

)

~FileInputStream()

FileInputStream::~FileInputStream ( )

virtual

Member Function Documentation

CanRead()

bool FileInputStream::CanRead ( )

overridevirtual

Indicate whether there is data available to be read from the stream.

Implements AudioDataLib::ByteStream.

CanWrite()

bool FileInputStream::CanWrite ( )

overridevirtual

Indicate whether it is possible to write additional data to the stream.

Implements AudioDataLib::ByteStream.

GetSize()

uint64_t FileInputStream::GetSize ( ) const

overridevirtual

Return the amount of data (in bytes) currently stored in the stream.

Implements AudioDataLib::ByteStream.

ReadBytesFromStream()

uint64_t FileInputStream::ReadBytesFromStream ( uint8_t * buffer, uint64_t bufferSize )

overridevirtual

Read from this stream into the given buffer.

Parameters

[out]	buffer	This is a pointer to an array where bytes read from the stream will be written.
[in]	bufferSize	This is the size in bytes of the given array.

Returns

The number of bytes actually read from the stream and written to the given buffer is returned.

Implements AudioDataLib::ByteStream.

WriteBytesToStream()

uint64_t FileInputStream::WriteBytesToStream ( const uint8_t * buffer, uint64_t bufferSize )

overridevirtual

Write the given buffer to this stream.

Parameters

[in]	buffer	This is a pointer to the array of bytes to write to the stream.
[in]	bufferSize	This is the size of the given array in bytes.

Returns

The number of bytes actually written to the stream is returned.

Implements AudioDataLib::ByteStream.

---

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

• Source/Library/ByteStream.h
• Source/Library/ByteStream.cpp