FileInputStream Class Reference

An input stream that reads from a local file. More...

Inherits InputStream.

List of all members.

Public Member Functions
	FileInputStream (const File &fileToRead)
	Creates a FileInputStream.
	~FileInputStream ()
	Destructor.
const File &	getFile () const noexcept
	Returns the file that this stream is reading from.
Result	getStatus () const
	Returns the status of the file stream.
int64	getTotalLength ()
	Returns the total number of bytes available for reading in this stream.
int	read (void *destBuffer, int maxBytesToRead)
	Reads a set of bytes from the stream into a memory buffer.
bool	isExhausted ()
	Returns true if the stream has no more data to read.
int64	getPosition ()
	Returns the offset of the next byte that will be read from the stream.
bool	setPosition (int64 pos)
	Tries to move the current read position of the stream.

---

Detailed Description

An input stream that reads from a local file.

See also:

InputStream, FileOutputStream, File::createInputStream

---

Constructor & Destructor Documentation

FileInputStream::FileInputStream

(

const File &

fileToRead )

[explicit]

Creates a FileInputStream.

Parameters:

fileToRead

the file to read from - if the file can't be accessed for some reason, then the stream will just contain no data

FileInputStream::~FileInputStream

(

)

Destructor.

---

Member Function Documentation

const File& FileInputStream::getFile

(

)

const

Returns the file that this stream is reading from.

Result FileInputStream::getStatus

(

)

const

Returns the status of the file stream.

The result will be ok if the file opened successfully. If an error occurs while opening or reading from the file, this will contain an error message.

int64 FileInputStream::getTotalLength

(

)

[virtual]

Returns the total number of bytes available for reading in this stream.

Note that this is the number of bytes available from the start of the stream, not from the current position.

If the size of the stream isn't actually known, this may return -1.

Implements InputStream.

int FileInputStream::read	(	void *	destBuffer,
		int	maxBytesToRead
	)		[virtual]

Reads a set of bytes from the stream into a memory buffer.

This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).

Parameters:

destBuffer	the destination buffer for the data
maxBytesToRead	the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes.

Returns:

the actual number of bytes that were read, which may be less than maxBytesToRead if the stream is exhausted before it gets that far

Implements InputStream.

bool FileInputStream::isExhausted

(

)

[virtual]

Returns true if the stream has no more data to read.

Implements InputStream.

int64 FileInputStream::getPosition

(

)

[virtual]

Returns the offset of the next byte that will be read from the stream.

See also:

setPosition

Implements InputStream.

bool FileInputStream::setPosition

(

int64

newPosition )

[virtual]

Tries to move the current read position of the stream.

The position is an absolute number of bytes from the stream's start.

Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.

Returns:

true if the stream manages to reposition itself correctly

See also:

getPosition

Implements InputStream.

---

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

• juce_FileInputStream.h