water::FileInputStream Class Reference

#include <FileInputStream.h>

Inheritance diagram for water::FileInputStream:

Public Member Functions
	FileInputStream (const File &fileToRead)
	~FileInputStream ()
const File &	getFile () const noexcept
const Result &	getStatus () const noexcept
bool	failedToOpen () const noexcept
bool	openedOk () const noexcept
int64	getTotalLength () override
int	read (void *, int) override
bool	isExhausted () override
int64	getPosition () override
bool	setPosition (int64) override
Public Member Functions inherited from water::InputStream
virtual	~InputStream ()
int64	getNumBytesRemaining ()
virtual char	readByte ()
virtual bool	readBool ()
virtual short	readShort ()
virtual short	readShortBigEndian ()
virtual int	readInt ()
virtual int	readIntBigEndian ()
virtual int64	readInt64 ()
virtual int64	readInt64BigEndian ()
virtual float	readFloat ()
virtual float	readFloatBigEndian ()
virtual double	readDouble ()
virtual double	readDoubleBigEndian ()
virtual int	readCompressedInt ()
virtual String	readNextLine ()
virtual String	readString ()
virtual String	readEntireStreamAsString ()
virtual size_t	readIntoMemoryBlock (MemoryBlock &destBlock, ssize_t maxNumBytesToRead=-1)
virtual void	skipNextBytes (int64 numBytesToSkip)

Private Member Functions
void	openHandle ()
size_t	readInternal (void *, size_t)

Private Attributes
const File	file
void *	fileHandle
int64	currentPosition
Result	status

Additional Inherited Members
Protected Member Functions inherited from water::InputStream
	InputStream () noexcept

Detailed Description

An input stream that reads from a local file.

See also

InputStream, FileOutputStream, File::createInputStream

Constructor & Destructor Documentation

FileInputStream()

water::FileInputStream::FileInputStream ( const File & fileToRead )

explicit

Creates a FileInputStream to read from the given file.

After creating a FileInputStream, you should use openedOk() or failedToOpen() to make sure that it's OK before trying to read from it! If it failed, you can call getStatus() to get more error information.

~FileInputStream()

water::FileInputStream::~FileInputStream

(

)

Destructor.

Member Function Documentation

failedToOpen()

bool water::FileInputStream::failedToOpen ( ) const

inlinenoexcept

Returns true if the stream couldn't be opened for some reason.

See also

getResult()

getFile()

const File & water::FileInputStream::getFile ( ) const

inlinenoexcept

Returns the file that this stream is reading from.

getPosition()

int64 water::FileInputStream::getPosition ( )

overridevirtual

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

See also

setPosition

Implements water::InputStream.

getStatus()

const Result & water::FileInputStream::getStatus ( ) const

inlinenoexcept

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.

getTotalLength()

int64 water::FileInputStream::getTotalLength ( )

overridevirtual

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 will return -1.

See also

getNumBytesRemaining

Implements water::InputStream.

isExhausted()

bool water::FileInputStream::isExhausted ( )

overridevirtual

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

Implements water::InputStream.

openedOk()

bool water::FileInputStream::openedOk ( ) const

inlinenoexcept

Returns true if the stream opened without problems.

See also

getResult()

openHandle()

void water::FileInputStream::openHandle ( )

private

read()

int water::FileInputStream::read ( void * destBuffer, int maxBytesToRead )

overridevirtual

Reads some data 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. This must not be null.
maxBytesToRead	the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. This value must not be negative.

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 water::InputStream.

readInternal()

size_t water::FileInputStream::readInternal ( void * buffer, size_t numBytes )

private

setPosition()

bool water::FileInputStream::setPosition ( int64 newPosition )

overridevirtual

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 water::InputStream.

Member Data Documentation

currentPosition

int64 water::FileInputStream::currentPosition

private

file

const File water::FileInputStream::file

private

fileHandle

void* water::FileInputStream::fileHandle

private

status

Result water::FileInputStream::status

private

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/files/FileInputStream.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/water/files/FileInputStream.cpp