cpp3ds::FileInputStream Class Reference

Implementation of input stream based on a file. More...

#include <FileInputStream.hpp>

Inheritance diagram for cpp3ds::FileInputStream:

Public Member Functions
	FileInputStream ()
	Default constructor. More...
virtual	~FileInputStream ()
	Default destructor. More...
bool	open (const std::string &filename)
	Open the stream from a file path. More...
virtual Int64	read (void *data, Int64 size)
	Read data from the stream. More...
virtual Int64	seek (Int64 position)
	Change the current reading position. More...
virtual Int64	tell ()
	Get the current reading position in the stream. More...
virtual Int64	getSize ()
	Return the size of the stream. More...

Detailed Description

Implementation of input stream based on a file.

This class is a specialization of cpp3ds::InputStream that reads from a file on disk.

It wraps a file in the common cpp3ds::InputStream interface and therefore allows to use generic classes or functions that accept such a stream, with a file on disk as the data source.

In addition to the virtual functions inherited from cpp3ds::InputStream, cpp3ds::FileInputStream adds a function to specify the file to open.

cpp3ds resource classes can usually be loaded directly from a filename, so this class shouldn't be useful to you unless you create your own algorithms that operate on a cpp3ds::InputStream.

Usage example:

void process(cpp3ds::InputStream& stream);

cpp3ds::FileStream stream;
if (stream.open("some_file.dat"))
   process(stream);

cpp3ds::InputStream, cpp3ds::MemoryStream

Definition at line 44 of file FileInputStream.hpp.

Constructor & Destructor Documentation

cpp3ds::FileInputStream::FileInputStream

(

)

Default constructor.

virtual cpp3ds::FileInputStream::~FileInputStream ( )

virtual

Default destructor.

Member Function Documentation

virtual Int64 cpp3ds::FileInputStream::getSize ( )

virtual

Return the size of the stream.

Returns

The total number of bytes available in the stream, or -1 on error

Implements cpp3ds::InputStream.

bool cpp3ds::FileInputStream::open

(

const std::string &

filename

)

Open the stream from a file path.

Parameters

filename

Name of the file to open

Returns

True on success, false on error

virtual Int64 cpp3ds::FileInputStream::read ( void *  data, Int64  size  )

virtual

Read data from the stream.

After reading, the stream's reading position must be advanced by the amount of bytes read.

Parameters

data	Buffer where to copy the read data
size	Desired number of bytes to read

Returns

The number of bytes actually read, or -1 on error

Implements cpp3ds::InputStream.

virtual Int64 cpp3ds::FileInputStream::seek ( Int64  position )

virtual

Change the current reading position.

Parameters

position

The position to seek to, from the beginning

Returns

The position actually sought to, or -1 on error

Implements cpp3ds::InputStream.

virtual Int64 cpp3ds::FileInputStream::tell ( )

virtual

Get the current reading position in the stream.

Returns

The current position, or -1 on error.

Implements cpp3ds::InputStream.

---

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

• FileInputStream.hpp